Add AI discovery endpoints to docs site#30621
Merged
Merged
Conversation
Closed
5 tasks
…i/faq.json, /ai/service.json) Agent-Logs-Url: https://github.com/github/gh-aw/sessions/bd280bf2-75c7-4c94-b773-0000dc8c0aad Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/bd280bf2-75c7-4c94-b773-0000dc8c0aad Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add AI discovery endpoints to docs site
Add AI discovery endpoints to docs site
May 6, 2026
Contributor
|
Hey One small gap before this is ready to merge:
If you'd like a hand, you can assign this prompt to your coding agent:
|
pelikhan
approved these changes
May 6, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds machine-readable “AI discovery” endpoints to the docs site (served from docs/public/) and updates ignore rules so the new ai.txt file is committed.
Changes:
- Add
ai/summary.json,ai/service.json, andai/faq.jsonwith project metadata, capabilities, and Q&A. - Add
.well-known/ai.txtto advertise crawler permissions and link to the summary/llms resources. - Update root
.gitignoreto unignoredocs/public/.well-known/ai.txtdespite a global*.txtignore.
Show a summary per file
| File | Description |
|---|---|
| docs/public/ai/summary.json | Adds project summary metadata for AI consumers. |
| docs/public/ai/service.json | Adds machine-readable capabilities/engines/integrations metadata. |
| docs/public/ai/faq.json | Adds a structured FAQ for AI consumers. |
| docs/public/.well-known/ai.txt | Adds AI crawler permissions + pointers to discovery resources. |
| .gitignore | Unignores the new ai.txt file under docs/public/.well-known/. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/5 changed files
- Comments generated: 3
| @@ -0,0 +1,4 @@ | |||
| # GitHub Agentic Workflows - AI crawler permissions | |||
| "engines": [ | ||
| { "id": "copilot", "name": "GitHub Copilot" }, | ||
| { "id": "claude", "name": "Claude" }, | ||
| { "id": "codex", "name": "OpenAI Codex" }, |
| }, | ||
| { | ||
| "question": "Which AI engines does gh-aw support?", | ||
| "answer": "gh-aw supports multiple AI engines including GitHub Copilot (copilot), Claude (claude), OpenAI Codex (codex), and custom engines. The engine is specified in the workflow frontmatter with the `engine` field." |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
GEO Audit scored 0/6 on AI discovery endpoints. Adds four static files to
docs/public/(served as-is by Astro) to address this.New files
docs/public/.well-known/ai.txt— AI crawler permissions; points tollms.txtandai/summary.jsondocs/public/ai/summary.json— project name, description, docs URL, source repo, install commanddocs/public/ai/faq.json— 10 Q&A entries covering installation, engines, safe outputs, MCP, debugging, cache-memorydocs/public/ai/service.json— capabilities list, supported engines, GitHub integrations, licenseInfra
!docs/public/.well-known/ai.txtexception to.gitignore(root*.txtrule was swallowing it, same pattern asrobots.txt)