[Bug] Three file paths in GIT_STORAGE.md name files that do not exist #637

Closed
opened 2026-07-22 16:23:35 +00:00 by brenno · 1 comment
Owner

Found in the pre-publication documentation review.

Evidence: a script over 242 backtick-quoted paths in the public documentation found 15 non-existent paths, of which 12 are legitimate (future paths in the two unbuilt designs, COLLABORATION.md and PROCESS_IMPROVEMENT.md). The other three are in docs/design/GIT_STORAGE.md:1102-1106 — a document that states phases 0-6 have landed and that it is "written to be picked up cold: exact file paths…":

  • native_git_mirror.dart — exists as native_git_mirror_io.dart / _api / _factory / _stub
  • draft_mirror.dart — exists as draft_store*.dart (4 files)
  • git_cli_stub.dart — exists as git_cli_web.dart

The implementation is there; the names changed during construction and the map was not updated.

Why this matters: small, but it hits exactly the promise that document makes in its opening lines, and it is the one document where a wrong path leads a reader to conclude the feature does not exist. Five minutes of work.

Proposal: correct the three lines to the real filenames with a *(Corrected …)* note per the house style. Consider afterwards a gate in tool/ that checks backtick-quoted paths to lib/ in docs/ for existence, with the 12 design paths on a baseline, so this class of drift cannot recur.

Found in the pre-publication documentation review. **Evidence:** a script over 242 backtick-quoted paths in the public documentation found 15 non-existent paths, of which 12 are legitimate (future paths in the two unbuilt designs, `COLLABORATION.md` and `PROCESS_IMPROVEMENT.md`). The other three are in `docs/design/GIT_STORAGE.md:1102-1106` — a document that states phases 0-6 have landed and that it is "written to be picked up cold: exact file paths…": - `native_git_mirror.dart` — exists as `native_git_mirror_io.dart` / `_api` / `_factory` / `_stub` - `draft_mirror.dart` — exists as `draft_store*.dart` (4 files) - `git_cli_stub.dart` — exists as `git_cli_web.dart` The implementation is there; the names changed during construction and the map was not updated. **Why this matters:** small, but it hits exactly the promise that document makes in its opening lines, and it is the one document where a wrong path leads a reader to conclude the feature does not exist. Five minutes of work. **Proposal:** correct the three lines to the real filenames with a `*(Corrected …)*` note per the house style. Consider afterwards a gate in `tool/` that checks backtick-quoted paths to `lib/` in `docs/` for existence, with the 12 design paths on a baseline, so this class of drift cannot recur.
Author
Owner

Opgelost in `cc00070` (PR #655).

De drie paden wijzen nu naar native_git_mirror_io.dart, draft_store.dart en git_cli_web.dart, met vermelding van de _api/_factory/_stub-broers ernaast, plus een gedateerde correctienotitie.

De voorgestelde poort in tool/ die backtick-paden naar lib/ toetst zit hier niet in — dat is code en verdient een eigen afweging (de twaalf legitieme toekomstige paden in de ongebouwde ontwerpen zouden een basislijst nodig hebben).

Opgelost in \`cc00070\` (PR #655). De drie paden wijzen nu naar `native_git_mirror_io.dart`, `draft_store.dart` en `git_cli_web.dart`, met vermelding van de `_api`/`_factory`/`_stub`-broers ernaast, plus een gedateerde correctienotitie. De voorgestelde poort in `tool/` die backtick-paden naar `lib/` toetst zit hier niet in — dat is code en verdient een eigen afweging (de twaalf legitieme toekomstige paden in de ongebouwde ontwerpen zouden een basislijst nodig hebben).
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
LibreKAT/Ocideck#637
No description provided.