Skip to content

Add llms.txt generation for LLM-friendly documentation#1553

Merged
j178 merged 4 commits intoj178:masterfrom
shaanmajid:feat/llms-txt
Feb 4, 2026
Merged

Add llms.txt generation for LLM-friendly documentation#1553
j178 merged 4 commits intoj178:masterfrom
shaanmajid:feat/llms-txt

Conversation

@shaanmajid
Copy link
Collaborator

@shaanmajid shaanmajid commented Feb 4, 2026

Closes #1498

Generates llms.txt and llms-full.txt for the documentation site. Also generates markdown files at each path (e.g., /configuration/index.md), enabling LLMs to fetch raw markdown instead of HTML.

As mentioned in the issue, this wasn't natively possible, since Zensical doesn't yet support MkDocs's plugin ecosystem. I built llmstxt-standalone to work as a standalone llms.txt generator, respecting the config for mkdocs-llmstxt.

  • Configure llmstxt plugin in mkdocs.yml with section structure
  • Add docs-build and docs-compile mise tasks
  • Update CI to run llmstxt-standalone after zensical build

Note: the generated files are not served or visible when using zensical serve, but will be generated and published to docs site as part of the publish-docs workflow.

Preview:

Add llmstxt-standalone for generating LLM-friendly documentation files.
Configure llmstxt plugin in mkdocs.yml with section structure matching
the nav. Add docs-preview, docs-build, and docs-compile mise tasks.
Run llmstxt-standalone after zensical build to generate llms.txt and
llms-full.txt. Pin Python version for reproducible dependency resolution.
@shaanmajid shaanmajid requested a review from j178 as a code owner February 4, 2026 01:03
@codecov
Copy link

codecov bot commented Feb 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.56%. Comparing base (5c64e47) to head (3951a85).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1553      +/-   ##
==========================================
- Coverage   91.56%   91.56%   -0.01%     
==========================================
  Files          91       91              
  Lines       17875    17875              
==========================================
- Hits        16368    16367       -1     
- Misses       1507     1508       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@shaanmajid shaanmajid added the documentation Improvements or additions to documentation label Feb 4, 2026
Copy link
Owner

@j178 j178 left a comment

Choose a reason for hiding this comment

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

Thanks!

@j178 j178 merged commit d548c08 into j178:master Feb 4, 2026
48 of 49 checks passed
@shaanmajid shaanmajid deleted the feat/llms-txt branch February 4, 2026 06:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add llms.txt to documentation

2 participants