canon+docs: sweep canon_url → knowledge_base_url references#106
Merged
Conversation
Forward-facing documentation sweep aligning tool reference docs, consistency principle, and template with the rename landing in klappy.dev#101 and klappy/oddkit#108. Files updated: - canon/principles/consistency-same-pattern-every-time.md — one reference to `canon_url` values being server-invariant - docs/oddkit/tools/oddkit_{search,get,encode,orient,catalog,challenge, version,gate,cleanup_storage}.md — tool schema parameter references - docs/oddkit/tools/telemetry_public.md — telemetry schema field name and SQL query alias (blob6 was documented as canon_url; now documented as knowledge_base_url with the same underlying blob) - docs/examples/project-instructions-template.md — step 3 reference - docs/oddkit/IMPL-catalog-recent.md — temporal-discovery docs Intentionally NOT updated (historical records): - docs/planning/e0007-implementation-plan.md - docs/oddkit/proactive/handoff-to-new-conversation.md - docs/oddkit/proactive/e0007-validation.md These are archaeological records of epoch-7 planning and validation. Rewriting them to use current terminology would falsify the historical record. The terminology shift is documented in the PR landing this rename; readers of historical planning docs can infer the mapping. Companion PRs: - #101 (contract with new terminology) - klappy/oddkit#108 (tool implementation + smoke test)
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
1 participant
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
Forward-facing documentation sweep: rename
canon_url→knowledge_base_urlacross tool reference docs, the consistency principle, the public project-instructions template, and the IMPL docs.Why
Companion to the contract rename in
#101and the implementation rename inklappy/oddkit#108. The canary surfaced thatcanon_url/governance_source: "canon"are ODD-specific jargon that leaks into every caller's mental model. With zero reported external users today, migration cost is zero. Renaming now keeps the whole ecosystem consistent before any TruthKit consumer or external user sees the older terminology.Files updated
canon/principles/consistency-same-pattern-every-time.mddocs/oddkit/tools/oddkit_{search,get,encode,orient,catalog,challenge,version,gate,cleanup_storage}.mddocs/oddkit/tools/telemetry_public.md(schema field name + SQL alias)docs/examples/project-instructions-template.mddocs/oddkit/IMPL-catalog-recent.mdIntentionally NOT updated (historical records)
docs/planning/e0007-implementation-plan.mddocs/oddkit/proactive/handoff-to-new-conversation.mddocs/oddkit/proactive/e0007-validation.mdRewriting archaeological records of epoch-7 planning would falsify history. Readers can infer the mapping from the PRs landing this rename.
Merge order
klappy/klappy.dev#101(contract) merges firstklappy/oddkit#108(implementation) merges last, runs live smoke against preview before prod promotionRelated
klappy/klappy.dev#101— core-governance-baseline contract with new terminology (merged separately)klappy/oddkit#108— tool schemas + smoke test + strict-override fix with new terminologyNote
Low Risk
Low risk doc-only rename that updates parameter naming across specs and examples; main risk is temporary confusion if readers are on an older oddkit build that still expects
canon_url.Overview
Updates forward-facing canon and oddkit documentation to consistently refer to the repo override parameter as
knowledge_base_urlinstead ofcanon_url, including the consistency principle, the project-instructions template, and the catalog implementation notes.Tool reference docs’ JSON schemas/examples and
telemetry_public’s documented dataset field name + sample SQL are updated to match the new terminology.Reviewed by Cursor Bugbot for commit 5c6db2a. Bugbot is set up for automated code reviews on this repo. Configure here.