Description
Part of #747. Today the model is described only by decisions/vocabulary-model, which is a dated decision log, and one paragraph of AGENTS.md. Neither explains the model to a new reader.
Two documents, for two readers:
-
nameparser/vocab/README.md, a reference for anyone editing the TOML, shown by GitHub beside the files:- what a file means, and what
undandmulare for - how an entry is built, with worked entries (
do,van,fils) - a table of kinds by category, with the compiled set each feeds
- a table of properties: what each applies to, its default, behavioral or descriptive
- exclusions and bearer-count provenance
- adding a word:
tools/name_usage.py,tools/vocab/build.py,tools/vocab/query.py, the test - which names are reserved for later phases
The kind and property tables are checked by a test against the names
build.pyaccepts, so the reference cannot drift from the compiler. - what a file means, and what
-
docs/design/vocabulary-model-rfc.md, a design overview of where the model is going (alongsidenameparser-2.0-rfc.md): derived ambiguity (phase 2), prefer and strict packs (phase 3), order versus shape and the output model (phase 4), and the first-pack order.
decisions/vocabulary-model stays the log that records each decision when it lands.
Done when both documents are merged and the README's tables are test-checked.
Activity
Add nameparser/vocab/README.md, a reference for editing the vocabulary (
Add docs/design/vocabulary-model-rfc.md, where the vocabulary model i…
Add docs/design/vocabulary-model-rfc.md, where the vocabulary model i…
Add docs/design/vocabulary-model-rfc.md, where the vocabulary model i…