|
1 | 1 | # Architecture Docs |
2 | 2 |
|
3 | | -This directory tracks the architecture of Nimbus as it exists today and as it evolves through the refactor program. |
| 3 | +This directory now keeps a small, intentional set of architecture and product-planning documents. |
4 | 4 |
|
5 | | -## Documents |
| 5 | +## Read Order |
6 | 6 |
|
7 | | -- `overview.md`: system boundaries, package responsibilities, and cross-package relationships |
8 | | -- `review-flow.md`: end-to-end review lifecycle |
9 | | -- `workspace-flow.md`: workspace creation, inspection, reset, and deletion lifecycle |
10 | | -- `deployment-flow.md`: workspace deployment preflight, execution, polling, and cancellation |
11 | | -- `auth-flow.md`: hosted auth and GitHub OIDC exchange model |
12 | | -- `report-ui-flow.md`: report UI data loading, polling, routing, and user-visible states |
13 | | -- `review-studio-experience.md`: locked UX and product decisions for Review Studio |
14 | | -- `review-studio-experience-build-plan.md`: phased build plan and owner guardrails for Review Studio |
15 | | -- `review-studio-implementation-plan.md`: repo-specific implementation plan with file-level targets and rollout order |
16 | | -- `adr/`: architecture decision records for major structural changes |
| 7 | +1. `architecture.md` |
| 8 | + - Current source of truth for how Nimbus is structured today. |
| 9 | +2. `review-session-pivot.md` |
| 10 | + - Active product-direction and implementation handoff for the session-based review redesign, including the local-first branch/worktree return path. |
| 11 | +3. `review-session-implementation-handoff.md` |
| 12 | + - Current implementation-state handoff for the session-based review redesign, including validated CLI flows, adoption/merge-back behavior, and the next UI focus. |
| 13 | +4. `review-studio-experience.md` |
| 14 | + - Locked product and UX decisions for the current Review Studio model. |
| 15 | +5. `review-studio-implementation-plan.md` |
| 16 | + - Current shipped-state snapshot for the existing Review Studio implementation. |
| 17 | +6. `review-studio-experience-build-plan.md` |
| 18 | + - Historical pre-slice build sequencing and guardrails. |
| 19 | +7. `adr/` |
| 20 | + - Architecture decision records for major structural changes. |
17 | 21 |
|
18 | | -## Current Coverage |
| 22 | +## Related Docs Outside This Directory |
19 | 23 |
|
20 | | -- The overview, review-flow, workspace-flow, deployment-flow, auth-flow, and report-ui-flow documents are filled in for the current pre-refactor implementation. |
21 | | -- Module-level docs for key subsystems live under `docs/modules/`. |
| 24 | +- `docs/modules/*` |
| 25 | + - Focused subsystem deep dives. |
| 26 | +- `docs/refactor-baseline.md` |
| 27 | + - Historical pre-refactor verification snapshot. |
| 28 | +- `docs/refactor-audit.md` |
| 29 | + - Original refactor rationale and target package direction. |
| 30 | +- `docs/refactor-audit-phase-5.md` |
| 31 | + - Current refactor handoff for readability cleanup. |
| 32 | +- `docs/jsdoc-guidelines.md` |
| 33 | + - JSDoc rules used during readability and refactor work. |
22 | 34 |
|
23 | | -## Writing Rules |
| 35 | +## Why The Older Flow Docs Were Removed |
24 | 36 |
|
25 | | -- Document current behavior first. |
26 | | -- Record target-state changes only when they are approved or implemented. |
27 | | -- Keep flow docs focused on triggers, steps, state transitions, and failure modes. |
28 | | -- Link to concrete source files when documenting implementation details. |
29 | | -- Update these docs as part of major refactors, not as an afterthought. |
| 37 | +The previous per-flow baseline docs had drifted behind the current CLI and worker structure. |
| 38 | + |
| 39 | +Nimbus is easier to understand now with: |
| 40 | + |
| 41 | +- one current-state architecture document for the broad mental model |
| 42 | +- one active review-session pivot document for the redesign direction |
| 43 | +- one implementation-state handoff for what the review-session work actually shipped and validated |
| 44 | +- one stable Review Studio spec and one living Review Studio status doc |
| 45 | +- targeted module docs only where a subsystem still needs a deeper explanation |
0 commit comments