Skip to content

Add GitHub Action to generate LLM-optimized documentation#29

Open
seriouscoderone wants to merge 7 commits intoWebOfTrust:mainfrom
seriouscoderone:add-llm-docs-workflow
Open

Add GitHub Action to generate LLM-optimized documentation#29
seriouscoderone wants to merge 7 commits intoWebOfTrust:mainfrom
seriouscoderone:add-llm-docs-workflow

Conversation

@seriouscoderone
Copy link
Copy Markdown

@seriouscoderone seriouscoderone commented Feb 16, 2026

Summary

  • Integrates osodevops/docusaurus-llm-docs@v1 into the existing D-deploy-to-gh-pages.yml deploy workflow
  • Generates LLM-friendly documentation following the llmstxt.org standard as part of every deploy
  • Files are served alongside the site — no separate workflow needed

How it works

The LLM docs generation step runs between the Docusaurus build and the gh-pages deploy. It converts the built HTML pages into clean markdown and copies the output into ./build/ so they get deployed with the rest of the site:

  • /llms.txt — structured index of all documentation pages with links
  • /llms-full.txt — complete documentation in a single markdown file (for LLM context windows)
  • /markdown.zip — individual markdown files organized by section

Uses build directory discovery (not sidebar parsing) since keridoc uses Docusaurus autogenerated sidebars which the action doesn't yet support natively.

Tested on fork (seriouscoderone/keridoc)

  • 167 pages successfully processed in ~5 seconds
  • llms-full.txt: 2.9MB, 42,952 lines
  • llms.txt: 24KB index with links to all pages
  • markdown.zip: 868KB archive with 293 files

Test plan

  • Workflow runs successfully on fork
  • All 167 documentation pages discovered and converted
  • llms.txt contains structured index with correct URLs
  • llms-full.txt contains complete documentation content
  • markdown.zip contains individual markdown files
  • Verify files are accessible at weboftrust.github.io/keridoc/llms.txt after deploy

🤖 Generated with Claude Code

seriouscoderone and others added 7 commits February 15, 2026 19:49
Adds a new workflow using osodevops/docusaurus-llm-docs to generate
llms.txt, llms-full.txt, and markdown.zip from the built Docusaurus
site. These files make the documentation accessible to AI assistants
following the llmstxt.org standard.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The sidebar parser doesn't support Docusaurus autogenerated sidebars.
Point sidebar-path to a nonexistent file to trigger the fallback that
discovers pages directly from the build output HTML files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Adds a workflow using osodevops/docusaurus-llm-docs@v1 to generate
LLM-friendly documentation following the llmstxt.org standard.

Produces three outputs as downloadable artifacts:
- llms.txt: structured index of all documentation pages
- llms-full.txt: complete documentation in a single markdown file
- markdown.zip: individual markdown files organized by section

Triggers on docs changes pushed to main, or manually via workflow_dispatch.

Uses build directory discovery (not sidebar parsing) since keridoc uses
Docusaurus autogenerated sidebars which the action doesn't yet support.

Tested on fork: 167 pages processed, 2.9MB full doc, 868KB archive.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Move LLM docs generation from a standalone workflow into the existing
D-deploy-to-gh-pages.yml pipeline. The LLM docs step runs after the
Docusaurus build and before the gh-pages deploy, so llms.txt,
llms-full.txt, and markdown.zip are served alongside the site at:
- https://weboftrust.github.io/keridoc/llms.txt
- https://weboftrust.github.io/keridoc/llms-full.txt
- https://weboftrust.github.io/keridoc/markdown.zip

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Instead of only storing LLM docs as ephemeral build artifacts, commit
them to a llm-docs/ directory in the repo so they're permanently
accessible at a stable URL on GitHub.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@seriouscoderone
Copy link
Copy Markdown
Author

@henkvancann @kordwarshuis please review

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.

1 participant