Contributing to the documentation

Where documentation lives

• documentation/index.md: landing page
• documentation/guides/: conceptual and task-based guides
• documentation/examples/: documented samples
• include/flint/: source of the generated public API reference

Documentation guidelines

1. Verify code examples against the public headers before publishing.
2. Document ownership, lifetime, failure cases, and units/coordinate systems for public APIs.
3. Mark incomplete coverage with TODO rather than inventing behavior.
4. Favor short examples that compile over illustrative pseudocode.
5. Link guides to the relevant API symbols when those names are confirmed.

Build locally

From the repository root, with Doxygen and the theme installed:

doxygen .doxygen

Open docs/html/index.html. Generated output under docs/ should normally be ignored by Git unless the project deliberately publishes it.