Documentation Standards
Documentation Standards
Section titled “Documentation Standards”Required Sections (where applicable)
Section titled “Required Sections (where applicable)”- Purpose
- Entry points / usage
- API contract (props, context, return values)
- State and side effects
- Error/loading/empty behavior
- Dependencies and related files
Definition of Done for Doc Updates
Section titled “Definition of Done for Doc Updates”A frontend PR should include docs updates when it changes:
- shared component API
- context/provider contract
- module behavior or route flow
- architecture-level wiring
Writing Rules
Section titled “Writing Rules”- Keep examples copyable and current.
- Prefer exact file paths and type names.
- Avoid speculative docs; only document current behavior.
- Mark deprecated APIs explicitly.