docs: refresh user guide and README for v0.3.2 - #42
Merged
Conversation
…0RXDKQG2CSA2D0TXWJQZZ) Through v0.3.1 the bundle root's index.md and log.md were skipped by the entire validate loop, so the entry point was the one file where a broken link went unreported. v0.3.2 narrows that exemption to type/title only. - README: v0.3.2 roadmap bullet; graph engine test count 24 -> 25 - user-guide: what the narrowed exemption means for validate's severities - cli-reference: validate row now says link checks cover the root files; same test count fix Left plugin-guide.md alone: it only lists /okf-validate as a slash command. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WMk8bhkMEUWfHi7VYzMzFX
This was referenced Aug 3, 2026
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.
What this is
The user-facing docs refresh for v0.3.2, covering
docs/user_guide/*.mdandREADME.md— theuser-guideandreadmetargets inrelease.sync_docs.docs/designs/is handled by a separate agent; index convergence and the wiki publish happen centrally afterwards, so nothing underdocs/.index/is touched here.Why
v0.3.2 carries exactly one behaviour change, in
scripts/okf-graph.py'scmd_validate. Through v0.3.1 the loop opened with:That
continuewas meant to excuse the bundle root's two structural files from thetypeandtitlewarnings — they legitimately carry neither. But it skipped the whole loop body, including the broken-link and out-of-bundle-link checks. The result: a bundle'sindex.mdis its entry point and its most linked-from file, and it was the one file in the bundle where a broken link was never reported.v0.3.2 narrows the exemption to the two metadata checks it was always meant to cover. The links in those files are now validated like anyone else's.
What changed in the docs
README.md24→25casesdocs/user_guide/user-guide.mddocs/user_guide/cli-reference.mdvalidatetable row notes link checks cover the root files; same test count fixUser-visible consequences now documented:
index.mdorlog.mdis an error —validateexits1where it previously reported nothing.--strictgates it in CI.validatestill exits0on warnings, which the skills andokf-curate.shdepend on.index.mdis excused at any depth, but only the rootlog.mdis structural — a nestedsub/log.mdstill wants atypeandtitle. This is the invarianttest_root_index_and_log_have_their_links_validatedlocks down.Deliberately left alone
docs/user_guide/plugin-guide.md— its only mention of validation is the/okf-validaterow in the slash-command table. Nothing there went stale, and an unnecessary edit to a published page costs a wiki republish for nothing.validatewarning list inuser-guide.md— the four warning kinds are unchanged in v0.3.2; only their reach changed, which is what the new paragraph says.0.3.2by the release commit.Correction to the brief
The brief predicted the user-guide pages would still be describing pre-v0.3.1 behaviour. They are not.
docs/user_guide/*.mdshow up ingit diff v0.3.1..v0.3.2 --statwith substantial changes, but those are the v0.3.1 docs refresh, which landed after thev0.3.1tag was cut and so falls inside this range. Ambiguous-concept resolution, off-bundle link reporting, criticality escalation and the bundle-rooted-anywhere curation hook were all already documented and accurate. Only the v0.3.2 change itself was missing.One staleness the brief did not mention, caught by reading the range rather than the summary: v0.3.2 adds a test, so the
# graph engine — 24 casescomment in bothREADME.mdandcli-reference.mdwas off by one.grep -c '^def test_' tests/test_okf_graph.pynow returns 25.Verification
hooks/pre-commitexits0. Its only output is the pre-existingrendered pages/manifest stalewarning, which resolves in the centralia-renderpass.🤖 Generated with Claude Code
https://claude.ai/code/session_01WMk8bhkMEUWfHi7VYzMzFX