Files
breakpilot-compliance/docs-src
Benjamin Admin d72dcbacfb docs(adr): ADR-001 Runtime Deploy Policy
A dev deploy must always have a verifiable runtime effect. Deploy only on
runtime/API/data-model/reasoning/security changes; docs, reference suites, ADRs,
board and ownership texts are merged to origin/main but NOT pushed to dev (no Orca
build). Keeps the CI/CD history meaningful: every build == a runtime change.

Architecture/release decision (not a developer convention) -> own folder
docs-src/architecture/adr/. Non-runtime: this commit triggers no deploy, per its
own policy.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-06-27 06:51:00 +02:00
..

docs-src

MkDocs-based internal documentation site — system architecture, data models, runbooks, API references.

Port: 8011 (container: bp-compliance-docs) Stack: MkDocs + Material theme, served via nginx.

Build + serve locally

cd docs-src
pip install -r requirements.txt
mkdocs serve           # http://localhost:8000
mkdocs build           # static output to site/

Known debt (Phase 4)

  • index.md is 9436 lines — will be split into per-topic pages with proper mkdocs nav. Target: no single markdown file >500 lines except explicit reference tables.