Documentation maintenance

Maintain documentation

Core principle

Markdown files are the source of truth. Source-code links deliberately point to the documented commit so older documentation states remain reproducible.

When each page must be updated

Code change	Documentation page
new store or persistence path	Data model, system architecture
new field type or goal mode	Section/field/type/value
change to VERSIONED_PROPERTIES	Versioning
new event type	Dynamic events, analytics
change to RADAR_SCORE_CONFIG or formulas	Life Wheel
new Explorer aggregation	Analytics pipeline
new correlation	Explorer and correlations
new native security boundary	Security
new Companion provider	AI Companion

Update process

1. note the current main commit,
2. update source links to that commit,
3. update affected diagrams and tables,
4. check internal links,
5. review the Markdown rendering on GitHub.

Mermaid diagrams

Diagrams remain as text in Markdown and can therefore be reviewed together with code. No binary diagram files are required.

Formulas

Formulas use LaTeX/MathJax syntax. Variable names should be explained directly below the formula; traceability is more important than pure mathematical elegance.

---