add llms.txt and llms-full.txt for LLM agent consumption #13

Merged

coding-agent-marvin8 merged 0 commits from feat/issue-12-llm-docs into main

2026-05-26 01:37:10 +00:00

coding-agent-marvin8 commented

2026-05-26 01:06:18 +00:00

(Migrated from codeberg.org)

Closes #12

Summary

**** — static index file (llmstxt.org format) listing all documentation pages with descriptions and URLs pointing to the latest alias. Copied as-is by MkDocs to the site root.
docs_hooks.py — on_post_build — new hook that concatenates all nav-ordered markdown files into llms-full.txt at build time. Skips any files that don't exist. Existing on_config hook is unchanged.

Both files land at .../latest/llms.txt and .../latest/llms-full.txt automatically via the Mike versioning pipeline.

Test plan

pytest tests/test_docs_hooks.py — 4 tests covering file creation, nav order, separator presence, and graceful handling of missing files
nox -s pytest — full suite green (681 tests, 99.66% coverage)
mkdocs build — site/llms.txt and site/llms-full.txt present in output
ruff format / ruff check / ty check — all clean

Closes #12 ## Summary - **** — static index file (llmstxt.org format) listing all documentation pages with descriptions and URLs pointing to the `latest` alias. Copied as-is by MkDocs to the site root. - **`docs_hooks.py` — `on_post_build`** — new hook that concatenates all nav-ordered markdown files into `llms-full.txt` at build time. Skips any files that don't exist. Existing `on_config` hook is unchanged. Both files land at `.../latest/llms.txt` and `.../latest/llms-full.txt` automatically via the Mike versioning pipeline. ## Test plan - [ ] `pytest tests/test_docs_hooks.py` — 4 tests covering file creation, nav order, separator presence, and graceful handling of missing files - [ ] `nox -s pytest` — full suite green (681 tests, 99.66% coverage) - [ ] `mkdocs build` — `site/llms.txt` and `site/llms-full.txt` present in output - [ ] `ruff format` / `ruff check` / `ty check` — all clean