Skip to content

docs: vocabulary design record (M19) - #45

Merged
jgrodziski merged 1 commit into
mainfrom
docs/m19-vocabulary-design-record
Nov 5, 2026
Merged

jgrodziski merged 1 commit into
mainfrom
docs/m19-vocabulary-design-record

Conversation

@jgrodziski

Copy link
Copy Markdown
Contributor

Stacked on #44. Docs only, no code or test change.

What

docs/vocabulary.md, the design record of the vocabulary and glossary feature (issue #6, PLAN §20), in the style of docs/navigator.md and docs/insights.md. Sixteen sections:

VO-1 Words come from names, never from source: the rejected alternatives and the seven principles
VO-2 The lexicon is the profile's; the algorithm is one: the lexicon shape, what each of the eleven profiles declares, the validation codes
VO-3 The split: steps 0–5 with examples, the fast-check properties
VO-4 The classes: domain / technical / keyword / short, the 138-word shared list, --technical, the digest
VO-5 Roles and weights: occurrences vs carriers, why a qualifier weighs one
VO-6 Scopes: the fold's membership, stubs never speak, operation scope on demand
VO-7 The artifact codegraph.vocabulary/1: shape, closure / conservation / order-independence, the five fixtures' hand counts
VO-8 The command: reports, flags, usage errors, exit codes
VO-9 Drift against a business glossary
VO-10 The cloud and the SVG
VO-11 The page: the tab, carriers.json, the vocabulary:<word> city channel
VO-12 Layer 2: the words a model is asked to define, both block shapes, PROMPT_VERSION, the fingerprint cascade, the measured cost
VO-13 The store at version 2
VO-14 Layer 3: the readers (--word, --glossary, --polysemy, --concerns, --drift-insights, /glossary.json)
VO-15 Measured: the coverage table, the Broadleaf top-ten review, the PetClinic timings
VO-16 Deferred, explicitly

Every number in it was read from the shipped code, the built @codegraph/core lexicons and the plan's as-built notes, not restated from memory.

Also:

  • README.md: the docs-list line, and a paragraph under "Read its vocabulary" on the glossary half of the feature, which the README did not mention.
  • docs/cli.md: a "Design record" pointer at the end of the vocabulary section.

Plan

Closes the docs/vocabulary.md box of PLAN §20.4. The checkbox itself is left unticked for the as-built note.

Checks

Sixteen headings, balanced code fences, every table's rows match its header, every file the record names exists. No test reads these docs.

🤖 Generated with Claude Code

https://claude.ai/code/session_01PKCVh2RjqQgcaeCBoVEntz

Add docs/vocabulary.md, the design record of M19 (issue #6) in the
style of docs/navigator.md and docs/insights.md: sixteen sections,
VO-1 to VO-16, from the principle that words come from names to the
deferred list. Every number in it (the 138 technical words, the 60
function words, each profile's lexicon, the fixtures' hand counts,
the measured coverage and cost) was read from the shipped code and
the plan's as-built notes, not restated from memory.

README.md gains the docs-list line and a paragraph on the glossary
half of the feature, which it did not mention; docs/cli.md's
vocabulary section points at the record.

Closes the docs box of PLAN §20.4; the checkbox itself is left for
the as-built note.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PKCVh2RjqQgcaeCBoVEntz
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
codegraph c13b8c5 Commit Preview URL

Branch Preview URL
Nov 05 2026, 10:09 AM

@jgrodziski
jgrodziski changed the base branch from feat/m19c-polysemy-senses to main November 5, 2026 10:47
@jgrodziski
jgrodziski merged commit 40c8c2c into main Nov 5, 2026
51 checks passed
Sign up for free to 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