Repository navigation
Bring the documents back in line with the direction - #50
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The direction changed; four documents did not. Found by auditing rather than by
remembering, which is the only method this repository is entitled to use.
1. The roadmap contradicted the measurements
The README still carried the v0.1 roadmap:
"v0.2 — parser / model engine" is the entry two days of measurement refuted. Git
already ships per-language funcname heuristics;
git log -Lnarrowed 145 of thisrepository's file-level decay events to 23, and a peer's 132 to 39, on TypeScript and
Python alike with nothing configured. The parser this project was going to build is one
it should never build.
Replaced by the four horizons from
DIRECTION.md, each with the measurement that decidesit — H1 by #10, H2 by ADR-015's three-incident test, H3 by whether teams can cite a frozen
record at all, H4 by #5.
DIRECTION.mdgains the section recording why the parser entrywas deleted, with the general form this project had to learn twice in a day: check what
the dependency already does before building the thing it does.
2.
skills/reference/had no entry for INV-027 or INV-028 — and the checker was fine with itskills/reference/is the stated single home for the rules; the SKILL.md files cite byid instead of restating.
check_docsscanned all ofskills/, so a citation inside aSKILL.md satisfied "cited by a skill" and two rules landed with no reference entry at
all.
That is the drift this checker exists to catch, occurring in the checker. Fixed in code,
not in prose:
check_docsnow requires an entry inskills/reference/specifically, andthe two rules have real entries. Verified it fails when either heading is removed.
The assertion covering this said the invariants stay "tripled" across three homes. There
are four. The claim was wrong, not just its evidence — corrected, with the refuting change
in the log.
3.
DEVELOPMENT-PLAN.mdread as a plan, and its numbers had rottedIt said "Every phase is complete. 24/24 test groups, 96/96 assertions", referenced
tools/traceos.pyandschema/, and counted 22 invariants. All four have changed.It is now labelled history, not a plan, with a note saying why it is deliberately not
updated: a design record rewritten to match today's code stops being evidence of what was
decided and becomes a second, worse copy of the code — which is INV-001 applied to the
document about INV-001. The v0.1 numbers stay, marked as v0.1's.
4. Smaller
docs/decisions/README.mdsaid "14/14 ACCEPTED" and stopped at ADR-014; ADR-015 is listedwith its half-accepted status. README layout counts corrected (28 invariants, 15 ADRs,
13/9/16 test groups) and
DIRECTION.mdadded to the layout. The spec's Non-goals no longersays "TraceOS v0.1 is not an IDE" now that v0.1 is not the current version.
Checks
39/39 groups, 185/185 assertions,
check_docs28/28 with the stricter rule,check_locators38/38, ratchet exit 0 — discharged by re-readingcheck_docs.py, whichis what raised the finding in the first place.