Skip to content

docs: expand documentation site and add llms.txt generation#79

Merged
rororowyourboat merged 6 commits intomainfrom
dev
Mar 3, 2026
Merged

docs: expand documentation site and add llms.txt generation#79
rororowyourboat merged 6 commits intomainfrom
dev

Conversation

@rororowyourboat
Copy link
Collaborator

Summary

  • Add documentation pages for stockflow, control, and software packages (API refs, guides, getting started)
  • Add cross-cutting guides: best practices, DSL comparison, troubleshooting
  • Add Evolution of Trust example and update feature matrix
  • Add mkdocs-llmstxt plugin to auto-generate /llms.txt (index) and /llms-full.txt (full content) on every build — 162 pages across 11 sections

Test plan

  • uv run mkdocs build --strict passes
  • uv run ruff check packages/ passes
  • uv run ruff format --check packages/ passes
  • site/llms.txt and site/llms-full.txt generated with correct content

Generates /llms.txt (index) and /llms-full.txt (full content) from the
existing nav structure on every mkdocs build. All 162 doc pages across
11 sections are included. No external services or API keys required —
the plugin converts rendered HTML back to Markdown at build time.
@rororowyourboat rororowyourboat merged commit 1c41253 into main Mar 3, 2026
10 checks passed
rororowyourboat added a commit that referenced this pull request Mar 3, 2026
Merge pull request #79 from BlockScience/dev
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant