rl-docs-hub

Intake and Update Flow

Standard flow

1. Check rl-docs-hub first
   • Confirm whether the work already exists in docs.
   • Reuse shared standards instead of reinventing them in app pages.
2. Open or update the relevant app/shared docs
   • App docs: docs/apps/<repo>/
   • Governance docs: docs/governance/
   • Shared standards: docs/standards/
   • Gaps / drift tracking: docs/registers/
3. Capture the proposed shape before implementation
   • feature scope
   • design intent
   • business rules
   • interfaces / schemas
   • architecture and permissions
4. Mark the status clearly
   • Use the status model so readers know whether the page is draft, approved, or in sync with production.
5. Implement
   • Keep the docs open while coding; update them as decisions sharpen.
6. Review documentation before opening the PR
   • Validate links, accuracy, and alignment with standards.
7. Create the PR
   • Reference the relevant docs pages in the PR description.
8. Close gaps after review
   • If reviewers identify drift or missing material, update the docs hub before merge.

Intake checklist

Use this checklist for new work requests or major change requests:

• What product or app is affected?
• What feature or capability is being introduced or changed?
• What business rules matter?
• What API and data model changes are required?
• What architecture or flow changes are required?
• What AWS / IaC / permission impact exists?
• What decisions are already made versus still open?
• What standards or approved libraries are being relied on?
• Is any exception to standards being requested?

Update triggers

Documentation updates are required when any of the following changes:

• product scope or user-visible behavior
• business rules
• API contracts
• database schema
• service boundaries or data flows
• AWS architecture / IaC topology
• permission model
• approved stack or library choices
• important decisions or reversals