Generate an LLM-friendly version of the handbook (llms.txt) - #86
Merged
Conversation
Ponytail audit cleanup (no behavior change): - package.json: drop `"main": "index.js"` (no such file; unused on a docs site). - config.mts: GA `src` used a pointless template interpolation of a string literal — replaced with a plain string (same GA id). - theme/custom.css: remove two commented-out CSS lines in `.mermaid`. - templates/README.md: trim from 22 to 10 lines for three self-describing config files. `pnpm docs:build` passes; GA id unchanged in output. Closes #82 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Register vitepress-plugin-llms (1.13.2) in the VitePress Vite config so the build emits /llms.txt (llmstxt.org index) and /llms-full.txt (all pages) at the site root, served on GitHub Pages. Merged into the existing withMermaid vite config so both plugins run. Verified: pnpm docs:build on VitePress 2.0.0-alpha.18 generates both files (llms.txt ~295 tokens / 15 links; llms-full.txt ~35.1K tokens / 15 files). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
sn0wm1ku
approved these changes
Jul 10, 2026
2 tasks
2 tasks
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
Adds an LLM-friendly version of the handbook per the llms.txt standard, closing #85. The VitePress build now emits
/llms.txt(a link index of all pages) and/llms-full.txt(every page concatenated), served at the site root on GitHub Pages.Change
doc/.vitepress/config.mts— registervitepress-plugin-llmsby passing it throughwithMermaid:withMermaid({ vite: { plugins: [llmstxt()] } }).withMermaidmerges it with mermaid's own vite plugins, so no manual vite-config splicing is needed.package.json/pnpm-lock.yaml— add thevitepress-plugin-llmsdevDependency.Verification
pnpm docs:buildon VitePress2.0.0-alpha.18generates both files (llms.txt~295 tokens / 15 links;llms-full.txt~35K tokens / 15 pages).pnpm docs:previewserves them at/llms.txtand/llms-full.txt(real files, not the SPA fallback).withMermaiddoes the plugin merge.Notes & follow-up
vitepress-plugin-llmsis renderer-coupled to VitePress, so it won't carry over to the Astro POC (POC: move handbook off VitePress to a headless CMS with reader RBAC + Google Workspace auth #68 / POC (#68): git-backed handbook on Astro + Cloudflare — GitHub auth, review workflow, no CMS/DB #72). Both the current and POC stacks build from the samedoc/*.md, so the transition-proof path (a platform-agnostic generator, or an Astro endpoint reading the content collection) is filed as an advisory on POC (#68): git-backed handbook on Astro + Cloudflare — GitHub auth, review workflow, no CMS/DB #72.[[TOC]]left as-is: it surfaces in the llms output as escaped\[\[TOC]]. Verified this is standard remark re-serialization (not a bug); an LLM reads\[as an escaped literal[, so it's understood correctly — not worth a build-time strip.Closes #85.