Skip to content

docs: correct four README claims and index seven docs - #303

Merged
LKSNDRTMLKV merged 2 commits into
mainfrom
docs/accuracy-0-13-0
Sep 13, 2026
Merged

LKSNDRTMLKV merged 2 commits into
mainfrom
docs/accuracy-0-13-0

Conversation

@LKSNDRTMLKV

Copy link
Copy Markdown
Member

Release-checklist accuracy pass for 0.13.0 — the same methodology applied to dpp-core before 0.20.0. Every claim re-checked against the tree rather than re-read.

The README was wrong in four places

The crate map was missing a crate. dpp-render — the shared renderer extracted from dpp-resolver so the live read and the continuity tier's pre-rendered snapshot cannot drift apart — appeared nowhere, while all eleven siblings did.

The dpp-core table named seven crates where the workspace takes nine. dpp-aas and dpp-rules were both absent. dpp-rules is the notable one: it is taken with features = ["bundle"], which is the signed-ruleset channel the README's own trust-layer section advertises two screens further down. The README was selling a feature whose dependency it did not list.

The open-core table named a crate where a repository belongs. The Odal Core row read dpp-domain — one crate inside dpp-core — in a column headed Repository.

The resolver route table listed five of the eight routes router.rs serves. Missing every GS1 Digital Link variant beyond the bare /01/{gtin}:

Missing
/01/{gtin}/21/{serial} resolves on the GTIN; AI 21 identifies the record, not the product
/01/{gtin}/10/{batch}
/01/{gtin}/10/{batch}/21/{serial} the full shape this node's own carrier emits

The last one is the one that matters — the documented resolver did not include the URL this node actually prints on labels.

Seven documents were unreachable from the index

docs/README.md links 13 of the 20 documents under docs/. Unindexed: architecture/EVIDENCE-DOSSIER.md, guides/OPERATOR-SETUP.md, guides/WEBHOOKS.md, all three of governance/, and project/ENDPOINTS.md.

EVIDENCE-DOSSIER.md is the sharp one: the paragraph immediately below that index advertises evidence dossiers as a headline capability, and did not link the document explaining them. The root README does.

docs/project/ENDPOINTS.md is a second register of the HTTP surface

33 of the spec's 78 paths, last touched 2026-08-28.

Nothing in it is wrong — I checked every route it names against api/openapi.yaml and all 33 still exist. But a partial duplicate of an authoritative file drifts by construction, and this repo's own principle is that two registers of one fact drift while one does not.

Rather than syncing 45 routes into it — which would perpetuate exactly that — it now states at the top that the spec is authoritative, that its own tables are a partial illustration, and that a table disagreeing with the spec should be deleted rather than corrected. The genuinely non-duplicated content (how routes are mounted across the fused node, and which identity endpoints are deliberately unreachable there) is what it keeps.

🚨 A removed HTTP endpoint was filed under ### Changed

GET /integrator/api/v1/templates/battery is gone — replaced by battery-ev, battery-lmt, battery-industrial. The entry carried its own *(Breaking for the template route…)* marker and sat under Changed, where nobody reading for migrations would find it.

It now has a ### Breaking entry, with the rationale left under Changed where it was written. Found by sweeping [Unreleased] for breaking-change language outside ### Breaking — the same check that turned up three misfiled breaks in dpp-core 0.20.0, which is why it is now a checklist step rather than something I happened to do twice.

Two other entries matched the sweep and were correctly placed: an internal SUPPORTED_SECTORS const rename, and a dead-branch removal that explicitly states "No behaviour change".

RELEASE.md gains the checks that would have caught this

Its checklist also skipped from 6 to 8 — step 7 had never existed. That slot now holds the CHANGELOG-section sweep, and step 6 names what to reconcile the README against (crates/, [workspace.dependencies], dpp-resolver/src/router.rs) instead of saying "verify the README reflects the current API".

Verification

Docs-only — no source changes. The non-cargo gates all pass: spec-version-check ✅ outbound-check ✅ subjects-check ✅ mod-rs-check ✅ debug-check ✅ grants-check ✅ migrations-check ✅. CI runs the rest.

@LKSNDRTMLKV
LKSNDRTMLKV merged commit 0e0f816 into main Sep 13, 2026
14 checks passed
@LKSNDRTMLKV
LKSNDRTMLKV deleted the docs/accuracy-0-13-0 branch September 13, 2026 07:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant