From 5f17b54f659a62b1ab1380ee530b3c468e5062f8 Mon Sep 17 00:00:00 2001 From: saagpatel Date: Tue, 2 Jun 2026 19:30:12 -0700 Subject: [PATCH] docs: reconcile documentation to current code state --- DOC-RECONCILIATION.md | 94 ++++++++++++++++++++++--------------------- 1 file changed, 48 insertions(+), 46 deletions(-) diff --git a/DOC-RECONCILIATION.md b/DOC-RECONCILIATION.md index 3109162..0758622 100644 --- a/DOC-RECONCILIATION.md +++ b/DOC-RECONCILIATION.md @@ -14,84 +14,86 @@ ran no builds or tests. **Status:** `consistent` **Evidence:** `README.md` introduction, feature list, and tagline match the purpose evident in the codebase — Chrome CDP capture via MV3 extension (`apps/extension-mv3/`), desktop processing -shell (`apps/desktop-tauri/`), Rust correlation and detector crates, export bundles. +shell (`apps/desktop-tauri/`), Rust correlation and detector crates, export bundles with BLAKE3 +integrity. `docs/ARCHITECTURE.md` accurately describes all process boundaries and data flow. No change made. ### 2. Current State **Status:** `consistent` -**Evidence:** `Cargo.toml:18` workspace metadata (`mode = "local_beta"`) and `AGENTS.md` both +**Evidence:** `Cargo.toml:19` workspace metadata (`mode = "local_beta"`) and `AGENTS.md` both describe the project as active/local-beta. Phase report docs (`docs/PHASE10–PHASE14_*.md`) -confirm extensive implementation through release-automation phases. `AGENTS.md` portfolio note -("minimum-viable context") is portfolio-management metadata — `unverifiable` from code alone, -left unchanged. +confirm extensive implementation through release-automation phases. Commit `02ece7f` added +Chrome smoke evidence to `docs/PHASE6_SMOKE_EVIDENCE.md` with +`interactive_chrome_manual: pass|date=2026-05-31|observer=codex_browser_automation`, which +satisfies the manual gate documented in `docs/PHASE13_PUBLIC_CHANNEL_REPORT.md` and +`docs/PHASE14_ROLLOUT_AUTOMATION_REPORT.md`. `CHANGELOG.md` lists only `Unreleased / Initial +release`, consistent with the `0.1.0-beta` state in the release scripts. `AGENTS.md` portfolio +note ("minimum-viable context") is portfolio-management metadata — `unverifiable` from code +alone, left unchanged. No change made. ### 3. Stack -**Status:** `drifted` (partially) -**Evidence:** `Cargo.toml:3–11` workspace `members` lists six Rust crates: -`dtt-core, dtt-storage, dtt-correlation, dtt-detectors, dtt-export, dtt-integrity`. -Both `README.md` and `AGENTS.md` listed only four crates in the "Core engine" row, -omitting `dtt-export` and `dtt-integrity`. - -**Changes made:** - -- `README.md` line 48: `Rust crates: dtt-core, dtt-storage, dtt-correlation, dtt-detectors` - → `Rust crates: dtt-core, dtt-storage, dtt-correlation, dtt-detectors, dtt-export, dtt-integrity` -- `AGENTS.md` line 19: same four-crate list → same six-crate list +**Status:** `consistent` +**Evidence:** `Cargo.toml:3–11` workspace `members` lists seven Rust workspace members: +`apps/desktop-tauri/src-tauri` (dtt-desktop-core) plus six library crates — `dtt-core, +dtt-storage, dtt-correlation, dtt-detectors, dtt-export, dtt-integrity`. `README.md` and +`AGENTS.md` correctly represent these in two rows: "Desktop runtime | Tauri 2 (Rust)" and +"Core engine | Rust crates: dtt-core, dtt-storage, dtt-correlation, dtt-detectors, dtt-export, +dtt-integrity". All other stack rows verified consistent with manifests: +- `apps/desktop-tauri/ui/package.json:1` confirms `react: ^18.3.1` and TypeScript ✓ +- `apps/extension-mv3/package.json` confirms Chrome MV3 extension ✓ +- `package.json:8` confirms `packageManager: pnpm@11.1.2` and Cargo workspace ✓ +- BLAKE3 integrity and SQLite confirmed in crate structure ✓ -All other stack rows (`Tauri 2`, `Chrome MV3`, `SQLite/SQLx`, `React + TypeScript`, -`BLAKE3 hashing`, `pnpm/Cargo workspace`) verified consistent with the code. +No change made. ### 4. How To Run -**Status:** `drifted` (Node.js version only) -**Evidence:** `README.md` prerequisites listed "Node.js 18+". All five GitHub Actions workflows -under `.github/workflows/` pin `node-version: 24` (verified in `.github/workflows/release-internal-beta.yml:56`, -`release-extension-public.yml:47`, and others). The root `package.json:6` specifies -`"packageManager": "pnpm@11.1.2"`, and pnpm 11.x requires Node.js ≥ 20. Node 18 is -insufficient for this project. - -**Change made:** - -- `README.md` line 22: `Node.js 18+ and pnpm` → `Node.js 20+ and pnpm` - -All other How-to-Run claims verified consistent: - -- `pnpm install --frozen-lockfile` — root `package.json` present ✓ +**Status:** `consistent` +**Evidence:** All Quick Start commands verified: +- `pnpm install --frozen-lockfile` — root `package.json` present; `pnpm@11.1.2` specified ✓ - `pnpm --filter @dtt/desktop-ui build` — `apps/desktop-tauri/ui/package.json:2` confirms name `@dtt/desktop-ui` ✓ - `pnpm --filter @dtt/extension build` — `apps/extension-mv3/package.json:2` confirms name `@dtt/extension` ✓ -- `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 ✓ -- Extension dist path `apps/extension-mv3/dist` — confirmed by build script in `apps/extension-mv3/package.json:10` ✓ +- `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 ✓ +- Extension dist path `apps/extension-mv3/dist` — confirmed by build output target in extension package ✓ +- `README.md` prerequisite "Node.js 20+ and pnpm" — correct; `pnpm@11.1.2` requires Node ≥ 20, and CI workflows pin `node-version: 24` ✓ + +No change made. ### 5. Known Risks **Status:** `consistent` -**Evidence:** `AGENTS.md` Known Risks is a meta-note about recovery context, not a technical risk -claim. README has no explicit risk section. No contradiction found. +**Evidence:** `AGENTS.md` Known Risks section is a portfolio-management meta-note about +recovery context depth, not a technical risk claim. `README.md` has no risk section. No +doc-vs-code contradiction found in editable files. +No change made. ### 6. Next Move / Roadmap **Status:** `unverifiable` -**Evidence:** `docs/IMPLEMENTATION_PLAN.md` defines Phases 0–7 but execution tracking is split -across `docs/PHASE10–PHASE14_*.md`. The gap between plan phase numbering (0–7) and -execution phase numbering (10–14) is noted in `docs/IMPLEMENTATION_PLAN.md:4–14` as a -known sequence divergence. Forward-looking items are inherently unverifiable from code -alone; no doc text was changed. +**Evidence:** `AGENTS.md` next-move guidance ("Use this context plus the README and supporting +docs to resume the next active task, then promote the repo beyond minimum-viable…") is a +general instruction that cannot be confirmed or refuted from code. `docs/IMPLEMENTATION_PLAN.md` +defines historical phases 0–7; execution phase numbering (6–14) is tracked in separate phase +reports. Forward-looking items are inherently unverifiable from code alone; no doc text changed. --- ## Contradictions for Manual Review **`Cargo.toml:16`** — `license = "UNLICENSED"` in the workspace manifest contradicts the -root `LICENSE` file (MIT) and the README badge (`license-MIT`). This is a source-file -discrepancy, not a doc file, so it is outside the editable scope of this pass. +root `LICENSE` file (MIT) and the `README.md` badge (`license-MIT`). This is a source-file +discrepancy outside the editable scope of this pass. **Suggested fix:** change `Cargo.toml` line 16 to `license = "MIT"`. +*Note: this contradiction was also flagged in the previous reconciliation pass (2026-05-30) +and remains unresolved.* + --- ## Footer -Generated: 2026-05-30 20:31:19 PDT -Branch: docs/truth-up-2026-05-30 -HEAD reconciled against: 9a836540818498fb29623d511b6d21bf563bad30 +Generated: 2026-06-02 19:29:32 PDT +Branch: docs/truth-up-2026-06-02 +HEAD reconciled against: 02ece7ffa3efbbd0badf6b82d5d591528c2cc5b5