-
Notifications
You must be signed in to change notification settings - Fork 345
add curated llms.txt for agents #2905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR replaces the previously auto-generated llms.txt with a curated, hand-authored index and introduces a new llms-full-guide.txt intended as an agent-oriented quick reference, while updating build and middleware plumbing to publish/serve the new files.
Changes:
- Add curated root
llms.txtand newllms-full-guide.txtcontent file. - Update generation/build flow to copy hand-written LLM files into the output directory (with fallback logic implemented in the generator script).
- Update middleware + AI landing page links and extend
.gitignorefor generated/static LLM artifacts.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| middleware/llmsFiles.ts | Serves the new /llms-full-guide.txt with the correct content-type. |
| llms.txt | Adds curated top-level LLM index pointing to key doc sections and LLM artifacts. |
| llms-full-guide.txt | Adds a self-contained “quick reference” guide for agents (CLI, perms, config, examples). |
| generate_llms_files.ts | Adds copyHandwrittenFile() and uses it to copy curated files (with fallback generation for llms.txt). |
| ai/index.md | Updates “Key resources” and usage guidance to include the curated index + new guide. |
| _config.ts | Updates build step to copy curated files into the site output during FULL builds. |
| .gitignore | Ignores additional generated LLM artifacts under static/. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
philhawksworth
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
philhawksworth
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Replace auto-generated llms.txt with a hand-written curated index and add llms-full-guide.txt as an agent-oriented quick reference.
Both files are copied to the output directory at build time, with fallback to auto-generation for llms.txt. Updates middleware to serve the new file and fixes missing .gitignore entries.