Skip to content

Add llms.txt and llms-full.txt to documentation site#372

Merged
mattleibow merged 5 commits intomainfrom
copilot/enable-llms-text-for-docs
Mar 4, 2026
Merged

Add llms.txt and llms-full.txt to documentation site#372
mattleibow merged 5 commits intomainfrom
copilot/enable-llms-text-for-docs

Conversation

Copy link
Contributor

Copilot AI commented Mar 3, 2026

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 from docs/llms.md source template
  • llms-full.txt — Concatenation of docs/llms-full-header.md + index.md + docs/*.md glob for full-context ingestion

Supporting changes

  • docs/docfx.json — Both generated files added to resource section; llms.md and llms-full-header.md excluded from content build
  • .github/workflows/docs-deploy.yml — Runs generation script before DocFX build
  • .gitignore — Both docs/llms.txt and docs/llms-full.txt excluded (generated artifacts)

New doc pages are auto-discovered for llms-full.txt via glob. docs/llms.md needs 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.

- 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
github-actions bot pushed a commit that referenced this pull request Mar 3, 2026
@github-actions
Copy link

github-actions bot commented Mar 3, 2026

📖 Documentation Preview

The documentation for this PR has been deployed and is available at:

🔗 View Staging Documentation

🔗 View Staging Blazor Sample

This preview will be updated automatically when you push new commits to this PR.


This comment is automatically updated by the documentation staging workflow.

Copy link
Collaborator

@mattleibow mattleibow left a comment

Choose a reason for hiding this comment

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

@copilot please fix

…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>
Copy link
Contributor Author

Copilot AI commented Mar 3, 2026

@copilot please fix

All three review comments addressed in 01c2e05:

  • Header moved out of script into docs/llms-full-header.md
  • Hardcoded file list replaced with index.md + docs/*.md glob
  • llms.txt now generated from docs/llms.md template, both output files gitignored

github-actions bot pushed a commit that referenced this pull request Mar 3, 2026
Co-authored-by: mattleibow <1096616+mattleibow@users.noreply.github.com>
@mattleibow mattleibow marked this pull request as ready for review March 3, 2026 23:29
github-actions bot pushed a commit that referenced this pull request Mar 3, 2026
@mattleibow mattleibow merged commit cc5361f into main Mar 4, 2026
5 checks passed
@mattleibow mattleibow deleted the copilot/enable-llms-text-for-docs branch March 4, 2026 00:04
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.

2 participants