Development and maintenance¶
This section is for contributors and maintainers. User-facing build, run, and configuration guidance belongs elsewhere in the documentation tree.
General contribution and commit rules are in
CONTRIBUTING.md.
Development workflow¶
Topic |
Document |
|---|---|
Build and run tests |
|
Debugging techniques and build modes |
|
Public API and source style |
|
Header dependency discipline |
|
Documentation structure and checks |
|
Local unified documentation preview |
|
Documentation and release versions |
Design and project history¶
Topic |
Document |
|---|---|
Recorded architecture decisions |
|
Refactoring direction |
|
Relate the publication to runnable software |
|
Checkpoint publication contract |
|
Checkpoint state capture |
Documentation products¶
Product |
Source and build |
|---|---|
Unified web documentation |
Markdown plus Doxygen XML, rendered by Sphinx/MyST/Breathe |
C++ API extraction |
Public headers and examples, parsed by Doxygen into XML |
Printable handbook |
|
Figures and visual briefs |
Before merging a user-visible change, update the canonical guide or reference page that owns the changed contract and add a changelog entry when required. Avoid placing temporary issue notes or implementation TODOs in introductory user documentation.