Skip to content

feat: add LLM documentation generation to deploy workflow - #291

Open
seriouscoderone wants to merge 15 commits into
WebOfTrust:mainfrom
seriouscoderone:add-llm-docs
Open

feat: add LLM documentation generation to deploy workflow#291
seriouscoderone wants to merge 15 commits into
WebOfTrust:mainfrom
seriouscoderone:add-llm-docs

Conversation

@seriouscoderone

Copy link
Copy Markdown
Collaborator

Summary

  • Integrates osodevops/docusaurus-llm-docs GitHub Action into the deploy pipeline to generate LLM-optimized documentation
  • Adds a sidebar resolver script (scripts/generate-sidebar-for-llm.js) to handle Docusaurus autogenerated sidebars, which the action doesn't natively support
  • Fixes a broken MDX file (docs/video/keri-dev-meeting-March-28-2024.md) that prevented builds due to invalid JSX in an onclick attribute
  • Generated assets are both deployed to GitHub Pages and committed to llm-docs/ in the repo

Generated Files

After each deploy, these files are available:

  • /llms.txt — Lightweight navigation index (131 KB, 1104 pages)
  • /llms-full.txt — Complete documentation in a single file for LLM consumption (1.8 MB)
  • /markdown.zip — Archive of individual markdown files (766 KB)

How It Works

  1. npm run build creates the Docusaurus static site as usual
  2. scripts/generate-sidebar-for-llm.js scans the docs/ directory and generates an explicit sidebars-resolved.js (since the action can't handle { type: 'autogenerated' })
  3. osodevops/docusaurus-llm-docs@v1 converts the HTML build output to clean markdown and generates the three LLM files
  4. Files are copied into ./build/ for GitHub Pages deployment and ./llm-docs/ for repo persistence

Test plan

  • Workflow triggered and completed successfully on fork
  • 1104 of 1197 docs processed (93 skipped due to underscore-prefixed path mismatches in build output)
  • All three files accessible via GitHub Pages: llms.txt, llms-full.txt, markdown.zip
  • Files committed to repo under llm-docs/

🤖 Generated with Claude Code

seriouscoderone and others added 12 commits February 16, 2026 01:00
These files contained <<<<<<< HEAD / ======= / >>>>>>> upstream/main
conflict markers that were committed without being resolved. Keeps the
upstream/main side in all cases:
- 3 annotated-copies files (different auto-generated accordion IDs)
- 2 glossary files (self-authenticating.md, streamer.md)
- overview-and-context.mdx (auto-generated table data)
- overview.json (auto-generated JSON data)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Resolve merge conflict markers in 7 files
…reamer.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Integrates osodevops/docusaurus-llm-docs GitHub Action to generate
LLM-optimized documentation (llms.txt, llms-full.txt, markdown.zip)
during the deploy pipeline. Assets are both deployed to GitHub Pages
and committed to the repo under llm-docs/.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The onclick-based img-to-video swap used escaped quotes that MDX
cannot parse, causing the Docusaurus build to fail with
"Unterminated JSX contents".

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The osodevops/docusaurus-llm-docs action cannot handle Docusaurus
autogenerated sidebars. Added a script that scans the docs directory
and generates an explicit sidebars-resolved.js with all 1197 docs
for the action to consume.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
seriouscoderone and others added 3 commits August 1, 2026 09:21
Brings 23 upstream commits into the branch that generates llms-full.txt so the
LLM export reflects current WOT-terms content.
@seriouscoderone

Copy link
Copy Markdown
Collaborator Author

Merged current main into the branch today; the deploy workflow re-ran green and republished gh-pages including llms-full.txt. The branch is no longer behind.

The diff spans 15 files because it also carries the #290 conflict-marker fixes and some content-sync commits. Happy to rebase it down to just the workflow change (.github/workflows/D-deploy-to-gh-pages.yml) once #290 lands, if that is easier to 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.

2 participants