Skip to content

README.md

Latest commit

 

History

History
40 lines (33 loc) · 1.52 KB

README.md

File metadata and controls

40 lines (33 loc) · 1.52 KB

Documentation map

A compact map of the github-agent-bridge documentation set.

Start here

Need Document Type
Understand what this project is ../README.md Overview
Install a deployment installation.md How-to
Understand system design architecture.md Explanation
Configure policy policy-reference.md Reference
Roll out safely shadow-canary.md How-to
Operate production operations.md How-to
Configure dashboard GitHub OAuth dashboard-github-oauth.md How-to
Develop the bridge development.md How-to
Diagnose known failures failure-modes.md Reference
Understand release automation releases.md Reference
Keep scope clean scope.md Explanation

Mental model

flowchart TD
    A[Scope] --> B[Architecture]
    B --> I[Installation]
    I --> C[Policy]
    C --> D[Shadow/canary rollout]
    D --> E[Operations]
    B --> F[Development]
    F --> G[Releases]
    E --> H[Failure modes]
Loading

Documentation rules

  • Keep reference documents factual and table-driven.
  • Keep how-to documents task-oriented and procedural.
  • Keep explanation documents focused on why the system exists and how pieces relate.
  • Do not bury operational warnings inside long prose; use callouts and checklists.