feat: add LLM documentation generation to deploy workflow#291
Open
seriouscoderone wants to merge 12 commits intoWebOfTrust:mainfrom
Open
feat: add LLM documentation generation to deploy workflow#291seriouscoderone wants to merge 12 commits intoWebOfTrust:mainfrom
seriouscoderone wants to merge 12 commits intoWebOfTrust:mainfrom
Conversation
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>
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
2 participants
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
scripts/generate-sidebar-for-llm.js) to handle Docusaurus autogenerated sidebars, which the action doesn't natively supportdocs/video/keri-dev-meeting-March-28-2024.md) that prevented builds due to invalid JSX in an onclick attributellm-docs/in the repoGenerated 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
npm run buildcreates the Docusaurus static site as usualscripts/generate-sidebar-for-llm.jsscans thedocs/directory and generates an explicitsidebars-resolved.js(since the action can't handle{ type: 'autogenerated' })osodevops/docusaurus-llm-docs@v1converts the HTML build output to clean markdown and generates the three LLM files./build/for GitHub Pages deployment and./llm-docs/for repo persistenceTest plan
llm-docs/🤖 Generated with Claude Code