Skip to content

[plan] Add AI discovery endpoints to docs site (/.well-known/ai.txt, /ai/summary.json) #30484

@github-actions

Description

@github-actions

From the GEO Audit Report (discussion #30401): all AI discovery endpoints scored 0/6 on both targets.

Approach

Create static AI discovery files in docs/public/ (Astro serves public/ as static assets):

1. /.well-known/ai.txt

Create docs/public/.well-known/ai.txt:

# GitHub Agentic Workflows - AI crawler permissions
Allow: /
Llms-txt: https://github.github.com/gh-aw/llms.txt
Summary: https://github.github.com/gh-aw/ai/summary.json

2. /ai/summary.json

Create docs/public/ai/summary.json with structured project metadata:

{
  "name": "GitHub Agentic Workflows (gh-aw)",
  "description": "Write agentic AI workflows in natural language markdown, run as GitHub Actions.",
  "version": "latest",
  "docs": "https://github.github.com/gh-aw/",
  "source": "https://github.com/github/gh-aw",
  "install": "gh extension install github/gh-aw"
}

3. /ai/faq.json and /ai/service.json

Create minimal versions of these endpoints with key Q&A from the docs and service capability metadata.

Files to Create

  • docs/public/.well-known/ai.txt
  • docs/public/ai/summary.json
  • docs/public/ai/faq.json
  • docs/public/ai/service.json

Acceptance Criteria

  • /.well-known/ai.txt is accessible on the deployed docs site
  • /ai/summary.json returns valid JSON with project metadata
  • /ai/faq.json contains at least 5 common questions and answers
  • /ai/service.json describes the service capabilities

Generated by Plan Command for issue #discussion #30401 · ● 2.8M ·

  • expires on May 8, 2026, 1:53 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions