Skip to content

Commit 750cf5e

Browse files
committed
docs: Move codebase health audit to new design/audits/ folder
Audits are diagnostic snapshots, not feasibility analysis for proposed changes. Giving them their own top-level folder under design/ clarifies the distinction and leaves room for future audit artifacts.
1 parent 5e7544d commit 750cf5e

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

design/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Internal project design artifacts. Not published to readthedocs — that lives i
77
```
88
design/
99
├── adrs/ Architecture Decision Records
10+
├── audits/ Diagnostic snapshots (health, security, dependencies)
1011
├── interface-design/ Design system (tokens, layout, component specs)
1112
└── research/ Feasibility analysis and implementation planning
1213
```
@@ -23,6 +24,19 @@ ADRs record: context, decision, consequences, and alternatives considered. They
2324

2425
Design system specification for the web UI. Tokens (colors, spacing, typography), component patterns, and layout rules. Referenced by frontend code and UI-related issues.
2526

27+
### `audits/`
28+
29+
Point-in-time diagnostic snapshots of the codebase. Organized by date:
30+
31+
```
32+
audits/
33+
└── YYYY-MM-DD/
34+
├── research.md Main audit brief
35+
└── ... Additional artifacts (data, follow-up analysis)
36+
```
37+
38+
Audits are backward-looking — they assess the current state of the codebase and produce prioritized work items. They feed into multiple future efforts (refactors, test coverage, ADRs) rather than a single decision.
39+
2640
### `research/`
2741

2842
Feasibility analysis, implementation planning, and technical exploration. Organized by date and topic:

design/research/2026-02-17-codebase-health-audit/research.md renamed to design/audits/2026-02-17/research.md

File renamed without changes.

0 commit comments

Comments
 (0)