You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: auto-generate llms.txt and llms-full.txt from mkdocs
- Add scripts/generate-llms-docs.py that parses mkdocs.yml nav order, concatenates all doc pages, and strips MkDocs markup (admonitions, tabs, mermaid, badges)
- Generate llms-full.txt (11326 lines: complete docs) and llms.txt (751 lines: overview with links)
- Add .github/workflows/update-llm-docs.yaml to regenerate files on each push to docs/ and auto-commit changes
- Update .github/workflows/docs.yaml to run generation before mkdocs build
- Update docs/llm.md to document the automated process
Files now always in sync with source; no manual maintenance needed.
|[`llms-full.txt`](../llms-full.txt)| Complete documentation (~1900 lines) | Full reference for code generation and in-depth tasks |
9
+
|[`llms.txt`](../llms.txt)| Concise overview with links to all sections | Quick context for simple questions |
10
+
|[`llms-full.txt`](../llms-full.txt)| Complete documentation (all pages concatenated) | Full reference for code generation and in-depth tasks |
11
+
12
+
## How They Stay Up to Date
13
+
14
+
Both files are **auto-generated** from the MkDocs documentation pages by the [`scripts/generate-llms-docs.py`](https://github.com/kdroidFilter/Nucleus/blob/main/scripts/generate-llms-docs.py) script. A GitHub Actions workflow runs this script on every push to `main` that touches `docs/`, so `llms.txt` and `llms-full.txt` are always in sync with the documentation.
15
+
16
+
!!! tip "Contributing"
17
+
Never edit `llms.txt` or `llms-full.txt` manually — edit the source `.md` files in `docs/` and the script regenerates them automatically.
0 commit comments