Skip to main content

RGB Docs

RGB Internal Engineering Documentation

For engineering, operations, QA, and delivery collaboration, this site maintains RGB platform architecture, service boundaries, decision records, change plans, and production runbooks as the official internal reference synchronized with the repository.

Documentation Governance

  • Markdown in Git remains the source of truth, with every change reviewed through the repository.
  • Architecture, service boundaries, and production procedures stay reviewable and traceable.
  • Broken links and build errors fail CI before stale documentation reaches the site.
  • Specs, plans, and runbooks are archived by change lifecycle so decisions keep their context.

System Baseline

Stable Documentation

Long-lived references for platform architecture, service boundaries, and engineering decisions.

Change Governance

Change Documentation

Specs, implementation plans, and operational procedures for migrations and feature changes.

Operational Support

Support Materials

Reference material, historical evidence, and reusable templates for daily collaboration.

Usage

Internal Collaboration Path

For architecture review, service changes, production issues, or release preparation, start with the stable references, then move into the relevant change documents and runbooks.

  1. Architecture: confirm topology, domain boundaries, and core data flows.
  2. Services: locate responsibilities, entry points, dependencies, workers, and operating modes.
  3. ADR: understand design tradeoffs instead of inferring intent only from current code.
  4. Specs and plans: confirm scope, goals, acceptance criteria, and execution status.
  5. Runbooks: check steps and risks before local, staging, or production operations.
  6. Reference: use historical and external material as evidence, not as the current design source.