Rust Docs

Rule

Document behavior that users and maintainers need. Prefer rustdoc examples and doctests for public API usage.

Hard Stops

Ask before:

• Documenting unsupported behavior or changing public contracts only to match docs.
• Adding docs sites, mdBook, OpenAPI generation, badges, diagrams-as-code, or hosting.
• Publishing docs externally or changing versioned docs.

Defaults