docs: add a CHANGELOG, index the unlisted docs, flag the stale estate figures - #15
Merged
Merged
Conversation
…estate figures The repository had no history of any kind — no CHANGELOG and no release-notes section in any README — so the only record of what changed since v0.1.0 was the git log. CHANGELOG.md now covers the 43 commits since the tag, grouped rather than enumerated. Three of ten docs were missing from the README index, including kg-graph-linking-design.md, which meant the design behind cross-layer linking was unreachable from the README. The estate measurements in that design doc and in the --federated section of the CLI reference were all taken before JVM package indexing shipped, when Go was the only source of package entities and the specificity floor filtered every one of them out. Rather than leave the numbers reading as current, both files now point at a single "Pending re-measurement" section listing every affected figure and what is expected to move. Re-deriving them needs the estate itself, so it stays open until then. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
kg-shared-service-design.md was still headed "proposal (not yet implemented)" even though phases 1-4 are in and per-user auth is built behind the pluggable verifier. Its own Rollout phases section already recorded that, so the header contradicted the body. Two other claims falsified by shipping: - Sequencing said "Nothing here is built." Identity is threaded through the request path and token/oidc/github verifiers all exist in src/kg/internal/hub; proxy is the one that remains. - Identity "should carry groups from the start" — it does, as Groups. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Review Summary
Docs-only PR (CHANGELOG.md added, README index updated, two design docs annotated with "pending re-measurement" / status corrections). No code paths touched, matching the PR description's claim.
I fact-checked the testable claims in the diff against the actual working tree rather than taking them at face value:
docs/kg-shared-service-design.mdclaimsIdentityis threaded through the request path and thattoken/oidc/githubverifiers exist whileproxyremains outstanding. Confirmed:src/kg/internal/hub/auth.godefines theVerifierinterface andTokenVerifier;oidc.go/github.goimplementOIDCVerifier/GitHubVerifier;Identity.Groups []stringexists exactly as described; noproxy.go/ProxyVerifierexists in the package. The updated status header and body are accurate.CHANGELOG.mdfeature/fix list spot-checked against the tree:src/kg/health.go,src/kg/personal.go,KG_HOMEenv var (src/kg/personal.go,scope.go),--public-onlyfilter (src/kg/search.go),recover()panic guard insrc/kg/internal/mcp/server.go,src/kg/Makefile'sinstall: keeps the binary it replacescomment, and absence of anyslack-mcp/upkdirectories — all consistent with the changelog's claims.docs/kg-graph-linking-design.md/docs/kg-cli-reference.md"Pending re-measurement" additions: cross-checked the new table's figures (5,138/50,993, 845, 3,204, 2,525, 3,359, 67,263) against the pre-existing numbers in the same file's body — they match exactly, so the new summary table isn't introducing drift. New anchor links (#pending-re-measurement,#problem,#measurement-gate--result,#acceptance,#open-questions,#rollout-phases) all resolve to real headings in the target files.- README table additions point at three real files (
docs/kg-graph-linking-design.md,docs/kg-shared-service-design.md,docs/kg-log-plugins.md), all present in the tree.
No fabricated or stale claims survived the check. No code, tests, or build config touched, so no build/test verification is applicable.
Critical Issues (must fix before merge)
None.
Major Issues (should fix)
None.
Minor Issues (optional)
README.md:155—docs/kg-log-plugins.mdis inserted betweenskills/README.mdand the Claude-integration docs rather than near the otherkg-*design docs a few rows up; the table isn't strictly grouped/alphabetized elsewhere either, so this is a nit, not a defect. Consider moving it next tokg-graph-linking-design.md/kg-shared-service-design.mdfor topical locality if the table's implicit grouping matters to maintainers.- Both "pending re-measurement" callouts point at
5211bc2as the commit where JVM package indexing shipped; I could not verify this SHA exists (shallow clone in this environment, no tags fetched), so it's unverified rather than confirmed — worth a maintainer's own sanity check before merge, though it's not something I could falsify.
Security Findings
None — no code changed.
Positive Observations
- Every quantitative and code-existence claim I checked (verifier types,
Identity.Groups, CLI subcommands, removed servers, env var name, panic recovery, public-only filter) matched the actual source tree exactly — unusually well-verified for a docs PR. - The "Pending re-measurement" sections in both
kg-cli-reference.mdandkg-graph-linking-design.mdare cross-linked to a single source of truth rather than duplicating stale numbers in two places with independent drift risk. - The
kg-shared-service-design.mdstatus correction removes a genuine contradiction (header said "not yet implemented" while the body's own Rollout phases section said otherwise) rather than just cosmetically updating a date.
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 repo had no history record of any kind — no CHANGELOG, no release-notes section in any of the five READMEs. The only account of what changed since
v0.1.0was the git log.CHANGELOG.md(new)Keep a Changelog format. One
[Unreleased]section covering the 43 commits since the tag, grouped by Added / Fixed / Changed / Removed rather than enumerated commit-by-commit. Notes that builds are version-stamped fromgit describe, which is why an installed binary reportsv0.1.0-43-g0ae49e6.README docs index
Three of ten docs were absent from the table:
docs/kg-graph-linking-design.md— so the design behind cross-layer linking was unreachable from the READMEdocs/kg-shared-service-design.mddocs/kg-log-plugins.mdPlus a row for the CHANGELOG.
Pending re-measurement
Every estate figure in
kg-graph-linking-design.md, and in the--federatedsection ofkg-cli-reference.md, was measured before JVM package indexing shipped (5211bc2). At that point the only package entitieskg indexminted were Go's bare identifiers, which the rule's specificity floor filters out — so those numbers cannot have come from an estate indexed by the binary current at the time.Rather than leave them reading as current, both files now point at a single Pending re-measurement section that lists every affected figure (2,525 derived edges, the 845 gate prediction, 3,359 discarded, the 5,138/50,993 corpus counts, estate size, load cost) and says which direction each should move. The section is written to be deleted once the numbers are reproduced.
Re-deriving them needs the estate itself on a machine at
5211bc2or later, so it stays open.Hub design doc status
docs/kg-shared-service-design.mdwas still headed "Status: proposal (not yet implemented)" despite phases 1–4 being in and per-user auth being built. Its own Rollout phases section already said so, so the header contradicted the body. Corrected, along with two other claims shipping had falsified:Identityis threaded through the request path andtoken/oidc/githubverifiers all exist insrc/kg/internal/hub;proxyis the one that remains.Identity"should carry groups from the start" — it does, asGroups.Docs only; no code paths touched.
🤖 Generated with Claude Code