Skip to content

docs: refresh the _llm state corpus and README status against the tree - #120

Merged
forkwright merged 1 commit into
mainfrom
docs/refresh-llm-state-and-readme-status
Aug 26, 2026
Merged

docs: refresh the _llm state corpus and README status against the tree#120
forkwright merged 1 commit into
mainfrom
docs/refresh-llm-state-and-readme-status

Conversation

@forkwright

Copy link
Copy Markdown
Owner

Finding

Two live docs-drift defects.

_llm/current_state.toml hadn't been touched since 2026-05-25 (3 commits total,
git log --follow) and still carried an unfilled <canonical-state-doc>/STATE.md
template placeholder in source_docs. The same broken placeholder was copy-pasted
into _llm/architecture.toml, _llm/decisions.toml, and _llm/glossary.toml
(4 sites total, grep -rn canonical-state-doc).

README.md's Status paragraph named issue #20 ("Phase 3 audit: missing
PeersChangedPatch...") as the "current audit backlog" topic set. #20 closed
2026-05-25T19:46:08Z. Of the issues open when the underlying finding was written,
neither #65 nor #67 was named, and a third (#61, open since 2026-07-21) wasn't
caught either — issue numbers embedded in prose go stale the moment the tracker
moves, independent of whether anyone remembers to update the doc.

Evidence

Why this matters

_llm/*.toml is the corpus other agents and tools read instead of re-deriving
repo state from scratch; a doc that's been silently wrong for three months
defeats that purpose worse than no doc at all, since it reads as authoritative.
A broken placeholder that's been copy-pasted across four files is the same
defect four times, not four defects. README's Status section is the first thing
a human or agent reads; naming a closed issue as "the current backlog" points
readers at the wrong problem set entirely.

Desired correction

Refresh _llm/current_state.toml's summary, current_phase, updated, and
recent[]/open_threads[] against present-day repo state; point every
<canonical-state-doc> placeholder at the real STATE.md; stop naming specific
issue numbers in README's Status prose and point at the tracker instead.

Done when:grep -rn "canonical-state-doc\|map deltas, zstd framing" returns
nothing, and _llm/current_state.toml's updated field and open_threads[]
reflect the tree at merge time. Both hold in this PR — see the diff.

Note (out of scope, flagged for the right owner)

forkwright/kanon's projects/hamma/STATE.md — the doc _llm/*.toml now
points at — is itself stale in a worse way than what this PR fixes: its
frontmatter claims last_updated: 2026-08-15 but its body still says Version: v0.1.0 (unreleased), references crates/hamma-core (renamed 2026-08-08, before
the claimed update date), and says "No dictyon code touched since 2026-04-13"
against 100+ merged PRs. That's a forkwright/kanon planning-doc defect, not a
forkwright/hamma one — this PR doesn't touch it, since kanon is a shared
planning tree outside this lane's scope.

_llm/current_state.toml carried an unfilled template placeholder path and
hadn't been touched since 2026-05-25 (3 commits total): it still said
updated="2026-05-01" while dictyon's shared-types crate was renamed to
mitos (#86), v0.2.0's changelog was cut (#58), and 100+ PRs landed. The
same broken placeholder was also copy-pasted into architecture.toml,
decisions.toml, and glossary.toml's source_docs arrays. The real canonical
doc exists in the kanon planning tree (the same target hamma's own README
auto-metadata block already links), so every occurrence now points there
instead of the dead template token.
README.md's Status paragraph named a closed audit issue as the "current
audit backlog" and didn't mention either issue actually open when it was
written; a third open issue wasn't caught either. Issue numbers in prose
go stale the moment the tracker changes, so the paragraph now points at
the tracker itself instead of naming specific issues.
@forkwright
forkwright merged commit 20a7195 into mainAug 26, 2026
11 checks passed
@forkwright
forkwright deleted the docs/refresh-llm-state-and-readme-status branch August 26, 2026 20:20
Sign up for freeto 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

@forkwright