Technical Reference¶

This section is the technical entry point for developers and maintainers. It should help you answer three questions quickly:

which document should I open first
how is the project architected
where is the detailed logic for the area I want to change

Start Here¶

Document catalog gives a short description of every major technical document
Architecture overview shows the project from several levels of detail using Mermaid diagrams
Bond engine architecture is the main handoff document for technical boundaries
Analysis models architecture defines the interpretation layer above the canonical result when the same simulation can be read in more than one defended way
Result model contract defines the canonical output boundary between engine, UI, exports, and future persistence
Data and persistence contracts define what should be durably stored independently from transient UI state

Internal engineering audits, review findings, and closure notes are intentionally kept only in the repository and are not part of the published documentation site.

Included Technical Areas¶

architecture and responsibility boundaries
shared strategy families
product-specific bond logic
anonymous telemetry operations
documentation publishing flow

Maintenance and Publishing¶

The published technical pages are generated from the repository source documents in docs/.

If you update source documentation:

run npm run docs:sync
run mkdocs serve -f mkdocs-site/mkdocs.yml for local preview
optionally run mkdocs build -f mkdocs-site/mkdocs.yml before publishing

At the moment, pushing the repository to main automatically republishes the online documentation site.

This should be treated as a demonstration-oriented publishing flow, not as a final production-grade documentation pipeline.