Documentation Policy

Last reviewed: 2026-04-21
Maintained by: Engineering

Purpose

Keep documentation trustworthy and operationally useful for engineers joining the project.

Mandatory Same-PR Documentation Updates

Documentation must be updated in the same PR when any of the following change:

• script name or script behavior
• environment variable contract
• port mapping
• migration flow or schema workflow
• app startup flow

PR Requirement

Every PR must include either:

1. Updated documentation, or
2. An explicit statement in PR description:

No documentation impact: <reason>

Documentation Ownership and Freshness

Each maintained doc should include metadata at top:

• Last reviewed: YYYY-MM-DD
• Owner: <team/person> or Maintained by: Engineering

Canonical Entry Point

Primary developer doc entrypoint:

• ../01-get-started/developer-index.md

When adding a new developer-facing doc, link it from developer-index.md.