Add GitHub Action to generate LLM-optimized documentation#29
Open
seriouscoderone wants to merge 7 commits intoWebOfTrust:mainfrom
Open
Add GitHub Action to generate LLM-optimized documentation#29seriouscoderone wants to merge 7 commits intoWebOfTrust:mainfrom
seriouscoderone wants to merge 7 commits intoWebOfTrust:mainfrom
Conversation
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>
Author
|
@henkvancann @kordwarshuis please review |
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.
Summary
D-deploy-to-gh-pages.ymldeploy workflowHow 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 sectionUses build directory discovery (not sidebar parsing) since keridoc uses Docusaurus
autogeneratedsidebars which the action doesn't yet support natively.Tested on fork (seriouscoderone/keridoc)
llms-full.txt: 2.9MB, 42,952 linesllms.txt: 24KB index with links to all pagesmarkdown.zip: 868KB archive with 293 filesTest plan
llms.txtcontains structured index with correct URLsllms-full.txtcontains complete documentation contentmarkdown.zipcontains individual markdown files🤖 Generated with Claude Code