Skip to content

Commit 3690d78

Browse files
committed
docs: rename to 'CodeBoarding Review'; real level-1 architecture sample
Title -> 'CodeBoarding Review'. Replace the toy gateway/cache sample with CodeBoarding's actual level-1 components (from .codeboarding/analysis.json), colored as a diff: 1 added (green), 2 modified (yellow), 1 deleted (red dashed), with edges colored to match.
1 parent 41df91c commit 3690d78

1 file changed

Lines changed: 22 additions & 11 deletions

File tree

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CodeBoarding Visual Architecture Review
1+
# CodeBoarding Review
22

33
Review system design on every pull request, not just the diff.
44

@@ -25,19 +25,30 @@ A PR comment looks like this:
2525

2626
```mermaid
2727
graph LR
28-
Gateway["API Gateway"]
29-
Auth["Auth Service"]
30-
Cache["Cache"]
31-
Gateway -- "routes to" --> Auth
32-
Auth -- "reads/writes" --> Cache
28+
Orchestration_Workflow_Manager["Orchestration & Workflow Manager"]
29+
Incremental_Analysis_Controller["Incremental Analysis Controller"]
30+
Static_Analysis_Engine["Static Analysis Engine"]
31+
Agentic_Intelligence_Core["Agentic Intelligence Core"]
32+
Health_Quality_Monitor["Health & Quality Monitor"]
33+
Rendering_Output_Engine["Rendering & Output Engine"]
34+
Persistence_Provider_Infrastructure["Persistence & Provider Infrastructure"]
35+
Orchestration_Workflow_Manager -- "triggers change detection" --> Incremental_Analysis_Controller
36+
Incremental_Analysis_Controller -- "passes filtered file sets" --> Static_Analysis_Engine
37+
Static_Analysis_Engine -- "provides CFGs and symbol tables" --> Agentic_Intelligence_Core
38+
Static_Analysis_Engine -- "supplies structural metrics" --> Health_Quality_Monitor
39+
Agentic_Intelligence_Core -- "delivers summaries and diagrams" --> Rendering_Output_Engine
40+
Health_Quality_Monitor -- "provides health reports" --> Rendering_Output_Engine
41+
Persistence_Provider_Infrastructure -- "supplies LLM clients" --> Agentic_Intelligence_Core
42+
Orchestration_Workflow_Manager -- "persists pipeline state" --> Persistence_Provider_Infrastructure
3343
classDef added fill:#1f883d,stroke:#0b5d23,color:#fff;
3444
classDef modified fill:#bf8700,stroke:#7d4e00,color:#fff;
3545
classDef deleted fill:#cf222e,stroke:#82071e,color:#fff,stroke-dasharray:5 3;
36-
class Cache added;
37-
class Auth modified;
38-
class Gateway deleted;
39-
linkStyle 0 stroke:#cf222e,stroke-width:2px,stroke-dasharray:5 3;
40-
linkStyle 1 stroke:#1f883d,stroke-width:2px;
46+
class Health_Quality_Monitor added;
47+
class Static_Analysis_Engine,Agentic_Intelligence_Core modified;
48+
class Persistence_Provider_Infrastructure deleted;
49+
linkStyle 3,5 stroke:#1f883d,stroke-width:2px;
50+
linkStyle 2 stroke:#bf8700,stroke-width:2px;
51+
linkStyle 6,7 stroke:#cf222e,stroke-width:2px,stroke-dasharray:5 3;
4152
```
4253

4354
## Quick start

0 commit comments

Comments
 (0)