Skip to content

Commit d14e76c

Browse files
authored
docs: reconcile documentation to current code state (#29)
1 parent 932b208 commit d14e76c

1 file changed

Lines changed: 48 additions & 46 deletions

File tree

DOC-RECONCILIATION.md

Lines changed: 48 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -14,84 +14,86 @@ ran no builds or tests.
1414
**Status:** `consistent`
1515
**Evidence:** `README.md` introduction, feature list, and tagline match the purpose evident in
1616
the codebase — Chrome CDP capture via MV3 extension (`apps/extension-mv3/`), desktop processing
17-
shell (`apps/desktop-tauri/`), Rust correlation and detector crates, export bundles.
17+
shell (`apps/desktop-tauri/`), Rust correlation and detector crates, export bundles with BLAKE3
18+
integrity. `docs/ARCHITECTURE.md` accurately describes all process boundaries and data flow.
1819
No change made.
1920

2021
### 2. Current State
2122

2223
**Status:** `consistent`
23-
**Evidence:** `Cargo.toml:18` workspace metadata (`mode = "local_beta"`) and `AGENTS.md` both
24+
**Evidence:** `Cargo.toml:19` workspace metadata (`mode = "local_beta"`) and `AGENTS.md` both
2425
describe the project as active/local-beta. Phase report docs (`docs/PHASE10–PHASE14_*.md`)
25-
confirm extensive implementation through release-automation phases. `AGENTS.md` portfolio note
26-
("minimum-viable context") is portfolio-management metadata — `unverifiable` from code alone,
27-
left unchanged.
26+
confirm extensive implementation through release-automation phases. Commit `02ece7f` added
27+
Chrome smoke evidence to `docs/PHASE6_SMOKE_EVIDENCE.md` with
28+
`interactive_chrome_manual: pass|date=2026-05-31|observer=codex_browser_automation`, which
29+
satisfies the manual gate documented in `docs/PHASE13_PUBLIC_CHANNEL_REPORT.md` and
30+
`docs/PHASE14_ROLLOUT_AUTOMATION_REPORT.md`. `CHANGELOG.md` lists only `Unreleased / Initial
31+
release`, consistent with the `0.1.0-beta` state in the release scripts. `AGENTS.md` portfolio
32+
note ("minimum-viable context") is portfolio-management metadata — `unverifiable` from code
33+
alone, left unchanged. No change made.
2834

2935
### 3. Stack
3036

31-
**Status:** `drifted` (partially)
32-
**Evidence:** `Cargo.toml:3–11` workspace `members` lists six Rust crates:
33-
`dtt-core, dtt-storage, dtt-correlation, dtt-detectors, dtt-export, dtt-integrity`.
34-
Both `README.md` and `AGENTS.md` listed only four crates in the "Core engine" row,
35-
omitting `dtt-export` and `dtt-integrity`.
36-
37-
**Changes made:**
38-
39-
- `README.md` line 48: `Rust crates: dtt-core, dtt-storage, dtt-correlation, dtt-detectors`
40-
`Rust crates: dtt-core, dtt-storage, dtt-correlation, dtt-detectors, dtt-export, dtt-integrity`
41-
- `AGENTS.md` line 19: same four-crate list → same six-crate list
37+
**Status:** `consistent`
38+
**Evidence:** `Cargo.toml:3–11` workspace `members` lists seven Rust workspace members:
39+
`apps/desktop-tauri/src-tauri` (dtt-desktop-core) plus six library crates — `dtt-core,
40+
dtt-storage, dtt-correlation, dtt-detectors, dtt-export, dtt-integrity`. `README.md` and
41+
`AGENTS.md` correctly represent these in two rows: "Desktop runtime | Tauri 2 (Rust)" and
42+
"Core engine | Rust crates: dtt-core, dtt-storage, dtt-correlation, dtt-detectors, dtt-export,
43+
dtt-integrity". All other stack rows verified consistent with manifests:
44+
- `apps/desktop-tauri/ui/package.json:1` confirms `react: ^18.3.1` and TypeScript ✓
45+
- `apps/extension-mv3/package.json` confirms Chrome MV3 extension ✓
46+
- `package.json:8` confirms `packageManager: pnpm@11.1.2` and Cargo workspace ✓
47+
- BLAKE3 integrity and SQLite confirmed in crate structure ✓
4248

43-
All other stack rows (`Tauri 2`, `Chrome MV3`, `SQLite/SQLx`, `React + TypeScript`,
44-
`BLAKE3 hashing`, `pnpm/Cargo workspace`) verified consistent with the code.
49+
No change made.
4550

4651
### 4. How To Run
4752

48-
**Status:** `drifted` (Node.js version only)
49-
**Evidence:** `README.md` prerequisites listed "Node.js 18+". All five GitHub Actions workflows
50-
under `.github/workflows/` pin `node-version: 24` (verified in `.github/workflows/release-internal-beta.yml:56`,
51-
`release-extension-public.yml:47`, and others). The root `package.json:6` specifies
52-
`"packageManager": "pnpm@11.1.2"`, and pnpm 11.x requires Node.js ≥ 20. Node 18 is
53-
insufficient for this project.
54-
55-
**Change made:**
56-
57-
- `README.md` line 22: `Node.js 18+ and pnpm``Node.js 20+ and pnpm`
58-
59-
All other How-to-Run claims verified consistent:
60-
61-
- `pnpm install --frozen-lockfile` — root `package.json` present ✓
53+
**Status:** `consistent`
54+
**Evidence:** All Quick Start commands verified:
55+
- `pnpm install --frozen-lockfile` — root `package.json` present; `pnpm@11.1.2` specified ✓
6256
- `pnpm --filter @dtt/desktop-ui build``apps/desktop-tauri/ui/package.json:2` confirms name `@dtt/desktop-ui`
6357
- `pnpm --filter @dtt/extension build``apps/extension-mv3/package.json:2` confirms name `@dtt/extension`
64-
- `cargo run -p dtt-desktop-core --features desktop_shell``apps/desktop-tauri/src-tauri/Cargo.toml:2` confirms crate name `dtt-desktop-core` with `desktop_shell` feature ✓
65-
- Extension dist path `apps/extension-mv3/dist` — confirmed by build script in `apps/extension-mv3/package.json:10`
58+
- `cargo run -p dtt-desktop-core --features desktop_shell``apps/desktop-tauri/src-tauri/Cargo.toml:2` confirms crate name `dtt-desktop-core`; `Cargo.toml:7` confirms `desktop_shell` feature ✓
59+
- Extension dist path `apps/extension-mv3/dist` — confirmed by build output target in extension package ✓
60+
- `README.md` prerequisite "Node.js 20+ and pnpm" — correct; `pnpm@11.1.2` requires Node ≥ 20, and CI workflows pin `node-version: 24`
61+
62+
No change made.
6663

6764
### 5. Known Risks
6865

6966
**Status:** `consistent`
70-
**Evidence:** `AGENTS.md` Known Risks is a meta-note about recovery context, not a technical risk
71-
claim. README has no explicit risk section. No contradiction found.
67+
**Evidence:** `AGENTS.md` Known Risks section is a portfolio-management meta-note about
68+
recovery context depth, not a technical risk claim. `README.md` has no risk section. No
69+
doc-vs-code contradiction found in editable files.
70+
No change made.
7271

7372
### 6. Next Move / Roadmap
7473

7574
**Status:** `unverifiable`
76-
**Evidence:** `docs/IMPLEMENTATION_PLAN.md` defines Phases 0–7 but execution tracking is split
77-
across `docs/PHASE10–PHASE14_*.md`. The gap between plan phase numbering (0–7) and
78-
execution phase numbering (10–14) is noted in `docs/IMPLEMENTATION_PLAN.md:4–14` as a
79-
known sequence divergence. Forward-looking items are inherently unverifiable from code
80-
alone; no doc text was changed.
75+
**Evidence:** `AGENTS.md` next-move guidance ("Use this context plus the README and supporting
76+
docs to resume the next active task, then promote the repo beyond minimum-viable…") is a
77+
general instruction that cannot be confirmed or refuted from code. `docs/IMPLEMENTATION_PLAN.md`
78+
defines historical phases 0–7; execution phase numbering (6–14) is tracked in separate phase
79+
reports. Forward-looking items are inherently unverifiable from code alone; no doc text changed.
8180

8281
---
8382

8483
## Contradictions for Manual Review
8584

8685
**`Cargo.toml:16`**`license = "UNLICENSED"` in the workspace manifest contradicts the
87-
root `LICENSE` file (MIT) and the README badge (`license-MIT`). This is a source-file
88-
discrepancy, not a doc file, so it is outside the editable scope of this pass.
86+
root `LICENSE` file (MIT) and the `README.md` badge (`license-MIT`). This is a source-file
87+
discrepancy outside the editable scope of this pass.
8988
**Suggested fix:** change `Cargo.toml` line 16 to `license = "MIT"`.
9089

90+
*Note: this contradiction was also flagged in the previous reconciliation pass (2026-05-30)
91+
and remains unresolved.*
92+
9193
---
9294

9395
## Footer
9496

95-
Generated: 2026-05-30 20:31:19 PDT
96-
Branch: docs/truth-up-2026-05-30
97-
HEAD reconciled against: 9a836540818498fb29623d511b6d21bf563bad30
97+
Generated: 2026-06-02 19:29:32 PDT
98+
Branch: docs/truth-up-2026-06-02
99+
HEAD reconciled against: 02ece7ffa3efbbd0badf6b82d5d591528c2cc5b5

0 commit comments

Comments
 (0)