Add llms.txt and llms-full.txt to documentation site#372
Merged
mattleibow merged 5 commits intomainfrom Mar 4, 2026
Merged
Conversation
- Create docs/llms.txt with curated index of docs and API reference - Create docs/generate-llms-full.sh to concatenate all docs into llms-full.txt - Update docs/docfx.json to include both files as resources in the build - Update docs-deploy.yml workflow to generate llms-full.txt before docfx build - Add docs/llms-full.txt to .gitignore (generated file) Co-authored-by: mattleibow <1096616+mattleibow@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Investigate and enable llms.txt for documentation
Add llms.txt and llms-full.txt to documentation site
Mar 3, 2026
|
📖 Documentation Preview The documentation for this PR has been deployed and is available at: This preview will be updated automatically when you push new commits to this PR. This comment is automatically updated by the documentation staging workflow. |
…use glob - Move llms-full.txt header from heredoc into docs/llms-full-header.md - Use docs/*.md glob instead of hardcoded file list for doc discovery - Make llms.txt generated from docs/llms.md source template - Add docs/llms.txt to .gitignore (now generated) - Exclude llms.md and llms-full-header.md from DocFX content build Co-authored-by: mattleibow <1096616+mattleibow@users.noreply.github.com>
Contributor
Author
Co-authored-by: mattleibow <1096616+mattleibow@users.noreply.github.com>
mattleibow
approved these changes
Mar 3, 2026
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.
Adds llms.txt support so LLMs can discover and ingest the docs site content at
mono.github.io/SkiaSharp.Extended/.Generation
Both files are generated at build time by
docs/generate-llms-full.sh:llms.txt— Curated index with links to all doc pages and API reference, copied fromdocs/llms.mdsource templatellms-full.txt— Concatenation ofdocs/llms-full-header.md+index.md+docs/*.mdglob for full-context ingestionSupporting changes
docs/docfx.json— Both generated files added toresourcesection;llms.mdandllms-full-header.mdexcluded from content build.github/workflows/docs-deploy.yml— Runs generation script before DocFX build.gitignore— Bothdocs/llms.txtanddocs/llms-full.txtexcluded (generated artifacts)New doc pages are auto-discovered for
llms-full.txtvia glob.docs/llms.mdneeds a manual link entry for each new page.💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.