[PR #190] [MERGED] docs: add llms.txt docs map generation (issue #135) #187

New issue

Closed

opened 2026-02-27 10:22:38 +03:00 by kerem · 0 comments

kerem commented

2026-02-27 10:22:38 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/mikeyobrien/ralph-orchestrator/pull/190
Author: @mikeyobrien
Created: 2/25/2026
Status: ✅ Merged
Merged: 2/25/2026
Merged by: @mikeyobrien

Base: main ← Head: docs/llms-txt-map-135

📝 Commits (1)

d60df3d docs: add llms.txt map generation and CI validation

📊 Changes

4 files changed (+165 additions, -1 deletions)

View changed files

📝 .github/workflows/docs.yml (+4 -1)
📝 docs/contributing/style.md (+2 -0)
📝 mkdocs.yml (+63 -0)
➕ scripts/validate_llms_txt.py (+96 -0)

📄 Description

Summary

add mkdocs-llmstxt plugin configuration in mkdocs.yml to generate /llms.txt with sectioned documentation map
pin docs CI dependency to mkdocs-llmstxt==0.5.0 in .github/workflows/docs.yml
add scripts/validate_llms_txt.py and run it in docs CI to enforce llms.txt structure/coverage
add contributor guidance in docs/contributing/style.md for keeping llmstxt sections in sync with docs IA

Validation

python3 -m venv .venv && source .venv/bin/activate && pip install mkdocs mkdocs-material mkdocs-material-extensions pymdown-extensions mkdocs-minify-plugin mkdocs-llmstxt==0.5.0
mkdocs build --strict --verbose
python scripts/validate_llms_txt.py site/llms.txt
cargo test -- --test-threads=1
cargo test -p ralph-core smoke_runner -- --test-threads=1

Closes #135

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/mikeyobrien/ralph-orchestrator/pull/190 **Author:** [@mikeyobrien](https://github.com/mikeyobrien) **Created:** 2/25/2026 **Status:** ✅ Merged **Merged:** 2/25/2026 **Merged by:** [@mikeyobrien](https://github.com/mikeyobrien) **Base:** `main` ← **Head:** `docs/llms-txt-map-135` --- ### 📝 Commits (1) - [`d60df3d`](https://github.com/mikeyobrien/ralph-orchestrator/commit/d60df3d54af79242cb2370a07435251ef79c432d) docs: add llms.txt map generation and CI validation ### 📊 Changes **4 files changed** (+165 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/docs.yml` (+4 -1) 📝 `docs/contributing/style.md` (+2 -0) 📝 `mkdocs.yml` (+63 -0) ➕ `scripts/validate_llms_txt.py` (+96 -0) </details> ### 📄 Description ## Summary - add mkdocs-llmstxt plugin configuration in mkdocs.yml to generate /llms.txt with sectioned documentation map - pin docs CI dependency to mkdocs-llmstxt==0.5.0 in .github/workflows/docs.yml - add scripts/validate_llms_txt.py and run it in docs CI to enforce llms.txt structure/coverage - add contributor guidance in docs/contributing/style.md for keeping llmstxt sections in sync with docs IA ## Validation - python3 -m venv .venv && source .venv/bin/activate && pip install mkdocs mkdocs-material mkdocs-material-extensions pymdown-extensions mkdocs-minify-plugin mkdocs-llmstxt==0.5.0 - mkdocs build --strict --verbose - python scripts/validate_llms_txt.py site/llms.txt - cargo test -- --test-threads=1 - cargo test -p ralph-core smoke_runner -- --test-threads=1 Closes #135 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>