Contributing documentation
Documentation is authored as plain Markdown and must remain useful directly on GitHub before any renderer is involved.
Source hierarchy
- Code, typed models, generated artifacts, release metadata, and validated registries are product-fact sources.
DATA_DICTIONARY.mdremains the deep core field reference.BENCHMARKS.mdremains generated/drift-checked.- Contract READMEs remain normative for contract schemas, budgets, boundaries, and examples.
CHANGELOG.mdremains the committed release source.ROADMAP.mdremains the concise repository-readable roadmap.
Summarize and link these sources; do not duplicate their tables line for line.
Version language
These pages track current main. Label behavior not present in the latest tagged
release Unreleased or Preview on main. Historical truth remains available through
matching tags and releases; do not create a second versioned route tree yet.
Safety and review
Do not include evaluator answer keys, private imports, salts, keys, local receipts, real personal data, or proprietary integration details. Changes to benchmark claims must follow the validated capability and publication registries.
Use the documentation ownership record to find the
canonical destination. Preserve historical USER_GUIDE.md headings that are still
registered routes, but make substantive guidance changes in the canonical owner.