README.md

manhattanreasoning-docs

User documentation for Manhattan Reasoning, built with MkDocs Material + mkdocstrings.

Published via GitHub Pages at https://docs.manhattanreasoning.com.

Structure

• docs/ — guides, concepts, and the hand-written REST API reference
• docs/reference/ — the Python API reference, auto-generated by mkdocstrings from the orchestrator source in the private Cloud_FPGA repo
• mkdocs.yml — site config
• .github/workflows/deploy.yml — builds and deploys on every push to main

Local development

The Python API reference reads the orchestrator source from the private Cloud_FPGA repo, checked out into _code/:

python3 -m venv .venv && source .venv/bin/activate
pip install -r docs-requirements.txt
./scripts/fetch-code.sh      # clones Cloud_FPGA into _code/ (needs read access)
mkdocs serve

If you don't have access to the private repo, mkdocs serve still works — the Python reference page will simply be empty.

Deploys

Pushing to main triggers the deploy workflow, which checks out this repo plus the private code (via a read-only deploy key), runs mkdocs build --strict, and publishes the result to the gh-pages branch.

To rebuild when the orchestrator API changes, the Cloud_FPGA repo can dispatch a code-updated event to this repo's deploy workflow.