Skip to content

Add llms.txt generation for GitHub Pages deployment#650

Merged
aaronpowell merged 8 commits intomainfrom
copilot/add-llms-txt-file
Feb 3, 2026
Merged

Add llms.txt generation for GitHub Pages deployment#650
aaronpowell merged 8 commits intomainfrom
copilot/add-llms-txt-file

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 3, 2026

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, agent, or skill file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, agent, or skill with GitHub Copilot.
  • I have run npm start and verified that README.md is up to date.

Description

Adds automated generation of llms.txt following the llmstxt.org specification. Enables LLMs to discover and index all repository resources (484 total: 145 agents, 139 prompts, 168 instructions, 32 skills). The file is generated during the website build process and deployed to GitHub Pages at https://github.github.io/awesome-copilot/llms.txt.

Implementation:

  • eng/generate-llms-txt.mjs: Extracts metadata from all resource types, handles multiline descriptions, generates spec-compliant Markdown. Accepts optional output directory parameter. Skill links point to SKILL.md files for consistency with repository documentation.
  • package.json: Added llms:generate script, integrated into website:build pipeline to generate llms.txt in website/public directory
  • .gitignore: Added llms.txt to ignore list (generated file, not committed to repository)
  • README.md: Added documentation section linking to GitHub Pages URL

Key decisions:

  • Reuses existing yaml-parser.mjs utilities for consistency
  • Converts multiline YAML descriptions to single-line format (spec requirement)
  • Warns on incomplete skill configurations (missing SKILL.md)
  • Generated as part of website build process, not committed to repository
  • Deployed to GitHub Pages for public access at https://github.github.io/awesome-copilot/llms.txt
  • Skill links reference SKILL.md files directly (e.g., skills/agentic-eval/SKILL.md) matching the pattern used throughout the repository

Type of Contribution

  • New instruction file.
  • New prompt file.
  • New agent file.
  • New collection file.
  • New skill file.
  • Update to existing instruction, prompt, agent, collection or skill.
  • Other (please specify): Build tooling - llms.txt generation infrastructure for GitHub Pages

Additional Notes

The llms.txt file provides a machine-readable catalog of all repository resources. LLMs can parse this to understand available agents, prompts, instructions, and skills without traversing the entire repository structure. The file is dynamically generated during website builds and served from GitHub Pages, ensuring it stays in sync with repository changes without cluttering the git history.

All resource links in the generated file use consistent patterns: agents, prompts, and instructions link to their respective .md files, while skills link to SKILL.md entrypoint files, matching the conventions used in repository documentation.


By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

Original prompt

I want to add a llms.txt (https://llmstxt.org/) to the website. It should list out all the agents, instructions, etc. in this repo along with their name and description


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 4 commits February 3, 2026 01:35
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Copilot AI changed the title [WIP] Add llms.txt file to list agents and instructions Add llms.txt generation for LLM discovery Feb 3, 2026
Copilot AI requested a review from aaronpowell February 3, 2026 01:39
@aaronpowell aaronpowell marked this pull request as ready for review February 3, 2026 01:41
Copilot AI review requested due to automatic review settings February 3, 2026 01:41
Copy link
Copy Markdown
Contributor

@aaronpowell aaronpowell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot I want the file to be generated as part of the website publishing step and available on the github pages site not just loose in the repo

Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Feb 3, 2026

@copilot I want the file to be generated as part of the website publishing step and available on the github pages site not just loose in the repo

Done! The llms.txt file is now generated as part of the website:build step and will be available at https://github.github.io/awesome-copilot/llms.txt on the GitHub Pages site. Changes in commit 7e23ac9:

  • Modified the script to accept an optional output directory parameter
  • Updated website:build to generate llms.txt in website/public
  • Removed llms.txt from repository root and added it to .gitignore
  • Updated README to link to the GitHub Pages URL instead of the repository file

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds automated generation of an llms.txt index (per llmstxt.org) so LLMs can discover agents, prompts, instructions, and skills in this repository.

Changes:

  • Adds eng/generate-llms-txt.mjs to scan repository resources and generate a spec-shaped llms.txt.
  • Updates package.json to add an llms:generate script and run it as part of npm run build.
  • Adds the generated llms.txt file and documents it in README.md.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.

File Description
package.json Adds llms:generate and runs it in the build pipeline.
eng/generate-llms-txt.mjs New generator script that extracts metadata and emits llms.txt.
llms.txt Generated catalog of agents/prompts/instructions/skills and repo docs links.
README.md Documents the presence/purpose of llms.txt.

Comment thread eng/generate-llms-txt.mjs
Comment thread eng/generate-llms-txt.mjs Outdated
Comment thread eng/generate-llms-txt.mjs
Copilot AI changed the title Add llms.txt generation for LLM discovery Add llms.txt generation for GitHub Pages deployment Feb 3, 2026
Copilot AI requested a review from aaronpowell February 3, 2026 01:47
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
@aaronpowell aaronpowell merged commit 939f148 into main Feb 3, 2026
9 checks passed
@aaronpowell aaronpowell deleted the copilot/add-llms-txt-file branch February 3, 2026 03:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants