Summary
Deploy a documentation site (MkDocs Material or Sphinx) to GitHub Pages covering installation, quickstart, API reference, architecture, and the library module catalog.
Motivation
The README is strong but a single file can't scale to cover the full API, worked examples, and the growing library module catalog (control, convex, circuits, DeFi, information theory, linear optimization, physics, topology). A proper doc site makes the project more accessible for adoption and contribution.
Suggested scope
- Framework: MkDocs with Material theme (lightweight, markdown-native, good for Python projects)
- Content structure:
- Getting started / installation
- Quickstart tutorial (axioms → hypothesis → proof → bundle)
- Core concepts (evaluation gates, evidence chain, foundation enforcement)
- API reference (auto-generated from docstrings via mkdocstrings)
- Library module catalog (one page per domain module)
- Examples gallery (link to runnable scripts in
examples/)
- Deployment: GitHub Actions workflow to build and deploy on push to main
- Seed content: The README already covers most conceptual content and can be refactored into the doc structure
Related
- CI workflow issue — docs build/deploy can share the GitHub Actions setup
Summary
Deploy a documentation site (MkDocs Material or Sphinx) to GitHub Pages covering installation, quickstart, API reference, architecture, and the library module catalog.
Motivation
The README is strong but a single file can't scale to cover the full API, worked examples, and the growing library module catalog (control, convex, circuits, DeFi, information theory, linear optimization, physics, topology). A proper doc site makes the project more accessible for adoption and contribution.
Suggested scope
examples/)Related