Skip to content

Generate an LLM-friendly version of the handbook (llms.txt) - #86

Merged
sn0wm1ku merged 5 commits into
mainfrom
i85-20260710-2049
Jul 10, 2026
Merged

Generate an LLM-friendly version of the handbook (llms.txt)#86
sn0wm1ku merged 5 commits into
mainfrom
i85-20260710-2049

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown

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 — register vitepress-plugin-llms by passing it through withMermaid: withMermaid({ vite: { plugins: [llmstxt()] } }). withMermaid merges it with mermaid's own vite plugins, so no manual vite-config splicing is needed.
  • package.json / pnpm-lock.yaml — add the vitepress-plugin-llms devDependency.

Verification

  • pnpm docs:build on VitePress 2.0.0-alpha.18 generates both files (llms.txt ~295 tokens / 15 links; llms-full.txt ~35K tokens / 15 pages).
  • pnpm docs:preview serves them at /llms.txt and /llms-full.txt (real files, not the SPA fallback).
  • Ponytail-reviewed — no over-engineering; withMermaid does the plugin merge.

Notes & follow-up

Closes #85.

actions-user and others added 4 commits July 10, 2026 03:05
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>
@github-actions github-actions Bot added addition A mirror label for the "Addition" issue type. 📝 Documentation Adding another markdown file or writing more comments. labels Jul 10, 2026
@sn0wm1ku
sn0wm1ku merged commit 12dd0ef into main Jul 10, 2026
1 check passed
@sn0wm1ku
sn0wm1ku deleted the i85-20260710-2049 branch July 10, 2026 12:02
@sn0wm1ku
sn0wm1ku restored the i85-20260710-2049 branch July 13, 2026 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

addition A mirror label for the "Addition" issue type. 📝 Documentation Adding another markdown file or writing more comments.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Generate an LLM-friendly version of the handbook (llms.txt)

2 participants