Contribution Guide
Authoring Rules
- Write role-first content under
docs/guides/<role>/...
- Keep role separation (
customer, company, association)
- Include API endpoint references only when implemented
- Include failure mode and recovery guidance for critical flows
Review Rules
- PR review from platform docs owner is mandatory
- Product/operations owner approval is required for flow changes
- Update
last_reviewed when making a functional change
Release Rules
- Publish versioned docs only from Git tags matching
vX.Y.Z
- Use
publish-docs-version.sh to enforce alias policy
- Keep
latest and stable in sync for release tags
- Use
next only for prerelease docs