Jérôme Bousquié e6f190e035 docs: add API documentation guidelines (rustdoc) in docs/DOCUMENTATION.md ...

Codifies the systematic documentation of public items with the API docs
in mind, based on the incidents from the last session: backticks around
every type (Option<Self>, Arc<Mesh>, [f32; 3]) to avoid unresolved-link
and unclosed-HTML-tag warnings, one doc comment per public item, the
#![warn(missing_docs)] policy, verifying '0 warnings' via cargo doc
before committing, and doc-test conventions (rust vs ignore blocks).

Applies to wsg-lib development from now on.

2026-09-16 09:45:33 +02:00

..

rules

préparation phase 1.1

2026-08-01 21:25:43 +02:00

tech

docs: align tech/ docs with current vs target state

2026-09-14 16:11:42 +02:00

DOCUMENTATION.md

docs: add API documentation guidelines (rustdoc) in docs/DOCUMENTATION.md

2026-09-16 09:45:33 +02:00

PLAN.md

examples: fix simple.rs to compile as the 15-line declarative model

2026-09-14 15:42:30 +02:00

ROADMAP.md

docs(roadmap): record frozen FIFO present-mode decision

2026-09-14 16:53:13 +02:00