An monsterbrain arbeiten¶
Die Docs sind die Wahrheit¶
Diese Docs sind die einzige Quelle der Wahrheit für alle, die monsterbrain entwickeln. Entscheidungen sind Anforderungen: Jedes Feature und jede Zeile Code muss zu ihnen passen. Jede Aussage, die eine Entscheidung braucht, ist ein Sphinx-Needs-Objekt mit ID und Status.
Objekt |
Präfix |
Status |
Bedeutung |
|---|---|---|---|
Entscheidung |
|
|
von Daniel entschieden – verbindlich |
Vorschlag |
|
|
Teil der technischen Details, noch nicht verbindlich |
Frage |
|
|
jemand muss etwas entscheiden – siehe Offene Fragen |
Ein angenommener Vorschlag wird zur Entscheidung: Er bekommt ein DEC_-Objekt unter Entscheidungen, und die technische Seite verlinkt darauf.
Die Docs bauen¶
Die Docs sind Markdown (MyST) in docs/, gebaut mit Sphinx. Ihre Python-Tools stehen in docs/pyproject.toml, getrennt von der App.
$ cd docs && uv sync
$ .venv/bin/sphinx-autobuild . _build/html --port 4341 # live preview
$ .venv/bin/sphinx-build -W -b html . _build/html # CI build, warnings fail
Veröffentlichte Docs¶
.github/workflows/docs.yml prüft die Docs bei jedem Push und Pull Request (Warnungen lassen den Build scheitern). Von Hand gestartet, veröffentlicht es sie im Branch gh-pages des öffentlichen Repositorys danwos/monsterbrain.docs, erreichbar unter https://monsterbrain.danwos.dev. Der Code hier bleibt privat.