Move the documentation to the line that ships, and correct it against the code
The docs lived on one lineage and the fleet code on another. That is why six pages described a shared fleet key as how an agent authenticates, why COLLECTOR-AUTH had to warn that the per-PC credential code was not in the repository it sat in, and why ADR-019 recorded a decision whose implementation was somewhere else. Documentation that cannot see the code it documents goes stale by construction, and no amount of editing fixes that. So the corpus moves here: 84 files, 56 pages, 20 ADRs, the proposals, INDEX.md, llms.txt and both gates. Filenames are unchanged, because a wiki page name is derived from the filename and a rename breaks every link anybody saved. THE POINT OF THE MOVE IS THE CORRECTION IT ENABLES. Every caveat that said "not in this tree" was false the moment the files landed beside the code, so each was rewritten from what is actually here: - COLLECTOR-AUTH gained the real enroll request body, the two bounds on the unauthenticated route (per-IP rate limit, pending cap with stale rows dropped before a real PC is refused), and the rejected pending reason that binds to the endpoint identity rather than the nonce. - ADR-019 now describes an implementation that is present, including its tests, and says plainly that what remains is the FLEET migration, not the code. - proposals/device-identity claimed phase 1 was unbuilt. plugins/computers declares deviceid on the collector schema and prefers it over the older fallbacks. Corrected in the page, its summary and the index. WINDOWS/IIS IS NOW DOCUMENTED AS THE LEGACY PATH, per the product decision, and carefully: it is what production runs today. Every Windows page opens by saying it is supported, not for a new site, and where a new site should go instead. No procedure was cut - an operator on an IIS box at 2am needs these pages to work exactly as well tomorrow. MIGRATE-TOPOLOGY stops being a footnote and becomes the off-ramp, which is why it nearly doubled: what was there did not match how the Docker stack really works here. The Docker material that already lived on this line was kept and given ownership rather than buried under the ported Windows-centric prose: DEPLOY now describes the four services, the migrate service that runs the upgrade chain before api starts, TLS terminated by nginx, and the plugin count corrected from thirteen to seventeen - a number both lineages had wrong. ROADMAP is rewritten from evidence rather than memory: what has shipped, read out of the changelog, the ADRs and the manifests, and ahead of it exactly two items - finalize a distributed release and polish the setup wizard. PROJECT-MAP is generated and was stale; the GENERATOR was what was wrong. --check passes now. API-REFERENCE is retired to a pointer. /api/docs serves 573 operations with derived auth, query parameters and harvested examples, and a hand-written page competing with that is a liability. The file stays so its wiki page and its inbound links survive. AND THE MOVE TURNED ON A SCRUB THAT HAD NEVER RUN HERE. test_docs_publishable keys on docs/*.md, which this line did not have, so it skipped - its own comment predicted what would surface. Porting the corpus activated it and it found 48 lines that must not reach a published wiki: branch names abbreviating the site, assistant-tooling paths, the site name in two deployment pages, and an employee ID in a Windows path that the scrub does not even look for.
This commit is contained in:
@@ -1,9 +1,24 @@
|
||||
<!-- docmeta
|
||||
purpose: reference
|
||||
audience: developer
|
||||
status: historical
|
||||
summary: Index of the 2026-09-11 audit drafts, what each one got wrong, and the 2026-09-18 corrections.
|
||||
loadwith: none
|
||||
-->
|
||||
# Wiki Page Drafts - 2026-09-11, revised 2026-09-18
|
||||
|
||||
> **Read with the date on it.** This is a point-in-time audit, kept as the
|
||||
> record of what was found and what it turned out to be, not as current
|
||||
> guidance. One thing it says repeatedly is no longer true: it was written when
|
||||
> this line carried no ADRs, and the full ADR set now lives beside it in
|
||||
> [docs/adr](../adr/README.md). Where this page says a decision record is
|
||||
> missing or lives elsewhere, look there first.
|
||||
|
||||
|
||||
This directory contains drafted wiki pages based on work completed Q3 2026. Copy
|
||||
these to the GitHub wiki at https://github.com/ge-aero/shopdb-flask/wiki.
|
||||
|
||||
**Revised 2026-09-18, branch gh-wj at 35d4fcd41.** A full review re-checked every
|
||||
**Revised 2026-09-18, the deployment branch at 35d4fcd41.** A full review re-checked every
|
||||
page here against the code. `Architectural-Findings-2026-09-11.md` was
|
||||
substantially wrong and now carries a verdict and evidence per finding.
|
||||
`Maintenance-Footprint-Baseline.md` is annotated where the tree has moved on.
|
||||
@@ -116,7 +131,7 @@ than "device token auth". Docker log rotation is still genuinely missing:
|
||||
**Remediation timeline:** Q4 2026 - Q4 2027
|
||||
|
||||
**2026-09-18: do not publish this page as it stood.** Re-checking it against
|
||||
gh-wj refuted most of it. There is no module-level cross-plugin import anywhere
|
||||
the deployment branch refuted most of it. There is no module-level cross-plugin import anywhere
|
||||
(`grep -rn "^from plugins\." plugins/ --include=*.py` = 0 hits) and `machines`
|
||||
does not import `computers` at all, so finding 1's cycle does not exist. No
|
||||
plugin deep-imports `shopdb.core` (0 hits), so finding 2 is refuted outright. No
|
||||
@@ -131,12 +146,12 @@ form.
|
||||
### 5. ADR Conformance - September 18, 2026
|
||||
**File:** `ADR-Conformance-2026-09-18.md`
|
||||
**Wiki path:** `ADRs/ADR-Conformance-2026-09-18`
|
||||
**Summary:** ADR-by-ADR result of the 2026-09-18 review of gh-wj at 35d4fcd41.
|
||||
**Summary:** ADR-by-ADR result of the 2026-09-18 review of the deployment branch at 35d4fcd41.
|
||||
Fourteen ADRs hold with cited evidence; eight items are recorded as violations
|
||||
or gaps, each with a file and line.
|
||||
|
||||
**Reads first, before the table:** the ADR set does not exist on this branch.
|
||||
`ls docs/adr` fails on gh-wj; ADR-001 through ADR-018 live only on the other
|
||||
`ls docs/adr` fails on the deployment branch; ADR-001 through ADR-018 live only on the other
|
||||
lineage. Nothing here states the rules and nothing here enforces them except
|
||||
`scripts/check-naming-and-style.sh`, which names exactly two ADRs (ADR-017 at
|
||||
line 343, ADR-015 at line 395). A handful of tests cover ADR ground without
|
||||
@@ -263,7 +278,7 @@ Dev PC (the internal git server) <--USB--> Work PC (GitHub) <--USB--> Production
|
||||
|
||||
```bash
|
||||
# On work PC
|
||||
cd C:\Users\270015376\Documents\github\flask-shopdb
|
||||
cd C:\Users\<you>\Documents\github\flask-shopdb
|
||||
./pull-shopdb-bundle.cmd # Creates tarball for transfer
|
||||
```
|
||||
|
||||
@@ -337,9 +352,9 @@ Gate tests validate generated documentation and API consistency:
|
||||
git add docs/openapi.json
|
||||
```
|
||||
|
||||
**Caveat for the wj branch (2026-09-18):** the parity gate cannot run here.
|
||||
**Caveat for the deployment branch (2026-09-18):** the parity gate cannot run here.
|
||||
`tests/test_api_inventory_parity.py` skips itself when `docs/api-inventory.json`
|
||||
is absent, and that file is not tracked on gh-wj, so `scripts/gen_openapi.py`
|
||||
is absent, and that file is not tracked on the deployment branch, so `scripts/gen_openapi.py`
|
||||
has no input either. `docs/openapi.json` on this branch is 377 paths at
|
||||
`info.version` 0.12.0 and documents none of the 24 routes added since
|
||||
2ac2e6d33. Regenerating it needs the inventory file from the other lineage.
|
||||
@@ -408,7 +423,7 @@ reads the collector key from `HKLM:\SOFTWARE\GE\ShopDB`, and
|
||||
pins to the same key by design. Publishing the old text would have told the next
|
||||
person to delete values the fleet depends on.
|
||||
|
||||
**What is actually built, as of gh-wj 35d4fcd41:**
|
||||
**What is actually built, as of the deployment branch at 35d4fcd41:**
|
||||
|
||||
- **Per-PC endpoint credentials.** An enrolled PC authenticates with
|
||||
`X-Endpoint-Credential` (`plugins/endpoints/api/agentauth.py`). The server
|
||||
@@ -563,7 +578,7 @@ yet.
|
||||
## Next Steps
|
||||
|
||||
1. Read the 2026-09-18 notes inside each page before pasting anything. All five
|
||||
pages in this folder have now been checked against gh-wj at 35d4fcd41.
|
||||
pages in this folder have now been checked against the deployment branch at 35d4fcd41.
|
||||
2. Copy to GitHub wiki at https://github.com/ge-aero/shopdb-flask/wiki
|
||||
3. Update wiki navigation/sidebar to include the new pages
|
||||
4. Link related pages. In particular, `Security-Audit-2026-09-11.md` finding 31
|
||||
@@ -574,12 +589,12 @@ yet.
|
||||
|
||||
**Three corrections that live outside this folder** and were therefore NOT made:
|
||||
|
||||
- `CLAUDE.md:3` and `:9` say PostgreSQL 15+; `docker-compose.yml:20` runs
|
||||
- the assistant-instructions file, lines 3 and 9, say PostgreSQL 15+; `docker-compose.yml:20` runs
|
||||
`mysql:8.4` and `.env.example:29` is a `mysql+pymysql://` URL.
|
||||
- `CLAUDE.md:31` says columns are snake_case; `CONTRIBUTING.md:17` says
|
||||
- the assistant-instructions file, line 31 says columns are snake_case; `CONTRIBUTING.md:17` says
|
||||
lowercase concatenated with no underscores, and that is what
|
||||
`scripts/check-naming-and-style.sh:236` enforces.
|
||||
- `CLAUDE.md:119` and the assistant quick-reference file, lines 14 and 135 repeat the
|
||||
- the assistant-instructions file, line 119 and the assistant quick-reference file, lines 14 and 135 repeat the
|
||||
ADR-016 device-token misattribution.
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user