Documentation Contributing Guide¶
Use the OrbitDeck docs site for stable operator and contributor guidance.
Expectations¶
- keep
README.mdanddocs/INSTALL_AND_RUN.mdaligned - prefer documenting current product behavior rather than aspirational behavior
- do not turn internal design notes into published docs pages
- keep route names and settings names synchronized with
app/main.pyandapp/models.py
Before opening a docs change¶
- Check the current route surface in
app/main.py. - Check settings models in
app/models.py. - Build the docs locally with
mkdocs build --strict.
Keep out of the docs site¶
- internal review logs
- redesign scratch notes
- local runtime artifacts