docs: Inaccuracies in AGENTS.md, README.md, and THIRDPARTY-LICENSES.md #214

Closed
opened 2026-09-06 12:35:29 +01:00 by gronod · 1 comment
Owner

Summary

Several documentation inaccuracies and specification discrepancies exist between markdown documentation files and the active codebase.

Identified Discrepancies

  1. Verification History Record Capacity:

    • README.md (line 30), ROADMAP.md (line 107), and AGENTS.md (line 173) document capacity as 500 records ("Historical verification logging persisted to verification_history.json (up to 500 records)").
    • src-tauri/src/quality_store.rs (line 10) defines:
      const HISTORY_CAP: usize = 1000;
      
      The implementation cap (1,000) diverges from all user-facing and architectural documentation (500).
  2. VerificationRecord Schema Field Name:

    • AGENTS.md (line 164) documents the schema as:

      printer: device name captured at print spooling (wizardState.printerName), or "Unknown".

    • In actual code (src-tauri/src/quality_store.rs line 18 and src/js/profcheck.js line 604), the field is serialized as printer_name.
  3. Third-Party Attribution (Delaunator vs. QuickHull):

    • THIRDPARTY-LICENSES.md (lines 26–39) and src/index.html (lines 1062–1065, About Dialog) credit Delaunator (Mapbox). Delaunator was superseded in Milestone 8 when the 3D Lab Convex Hull algorithm was introduced.
    • src/js/vendor/quickhull.js (quickhull3d, MIT License) is actively vendored and bundled for 3D gamut geometry computation, but is uncredited in THIRDPARTY-LICENSES.md.

Proposed Remediation

  1. Reconcile HISTORY_CAP in quality_store.rs and the documentation so they match (either update HISTORY_CAP to 500 or update README.md, ROADMAP.md, and AGENTS.md to 1,000).
  2. Correct the VerificationRecord field name from printer to printer_name in AGENTS.md.
  3. Update THIRDPARTY-LICENSES.md and src/index.html to remove Delaunator and include quickhull3d license attribution.
### Summary Several documentation inaccuracies and specification discrepancies exist between markdown documentation files and the active codebase. ### Identified Discrepancies 1. **Verification History Record Capacity**: - `README.md` (line 30), `ROADMAP.md` (line 107), and `AGENTS.md` (line 173) document capacity as **500 records** (`"Historical verification logging persisted to verification_history.json (up to 500 records)"`). - `src-tauri/src/quality_store.rs` (line 10) defines: ```rust const HISTORY_CAP: usize = 1000; ``` The implementation cap (1,000) diverges from all user-facing and architectural documentation (500). 2. **VerificationRecord Schema Field Name**: - `AGENTS.md` (line 164) documents the schema as: > `printer`: device name captured at print spooling (`wizardState.printerName`), or "Unknown". - In actual code (`src-tauri/src/quality_store.rs` line 18 and `src/js/profcheck.js` line 604), the field is serialized as `printer_name`. 3. **Third-Party Attribution (Delaunator vs. QuickHull)**: - `THIRDPARTY-LICENSES.md` (lines 26–39) and `src/index.html` (lines 1062–1065, About Dialog) credit `Delaunator (Mapbox)`. Delaunator was superseded in Milestone 8 when the 3D Lab Convex Hull algorithm was introduced. - `src/js/vendor/quickhull.js` (`quickhull3d`, MIT License) is actively vendored and bundled for 3D gamut geometry computation, but is uncredited in `THIRDPARTY-LICENSES.md`. ### Proposed Remediation 1. Reconcile `HISTORY_CAP` in `quality_store.rs` and the documentation so they match (either update `HISTORY_CAP` to 500 or update `README.md`, `ROADMAP.md`, and `AGENTS.md` to 1,000). 2. Correct the `VerificationRecord` field name from `printer` to `printer_name` in `AGENTS.md`. 3. Update `THIRDPARTY-LICENSES.md` and `src/index.html` to remove Delaunator and include `quickhull3d` license attribution.
gronod added the Kind/Documentation
Priority
Low
4
labels 2026-09-06 12:35:29 +01:00
Author
Owner

Resolved in commit c5ff3d1:

  • Updated VerificationRecord device field name documentation in AGENTS.md from printer to printer_name to match quality_store.rs and profcheck.js.
  • Reconciled verification history capacity documentation across README.md, ROADMAP.md, and AGENTS.md from 500 to 1,000 records to align with quality_store.rs (HISTORY_CAP = 1000) and test assertions.
  • Replaced obsolete Delaunator attribution with quickhull3d (MIT License) in THIRDPARTY-LICENSES.md and src/index.html (About Dialog).
Resolved in commit `c5ff3d1`: - Updated `VerificationRecord` device field name documentation in `AGENTS.md` from `printer` to `printer_name` to match `quality_store.rs` and `profcheck.js`. - Reconciled verification history capacity documentation across `README.md`, `ROADMAP.md`, and `AGENTS.md` from 500 to 1,000 records to align with `quality_store.rs` (`HISTORY_CAP = 1000`) and test assertions. - Replaced obsolete `Delaunator` attribution with `quickhull3d` (MIT License) in `THIRDPARTY-LICENSES.md` and `src/index.html` (About Dialog).
Sign in to join this conversation.