Skip to content

index.md

Latest commit

 

History

History
25 lines (18 loc) · 1.15 KB

index.md

File metadata and controls

25 lines (18 loc) · 1.15 KB

Reference

Reference — precise, look-it-up facts. Not a tutorial; no narrative.

Page What it gives you
Commands Every make target and CLI command, with exit-code meaning
Schema reference Generated entity tables + Mermaid ERD, produced from the enriched XSD

Authoritative specifications

The deeper, authoritative reference for this feature lives in the planning artifacts (outside the docs site, under version control):

  • specs/001-codespace-xml-scaffold/spec.md — the feature specification (WHAT/WHY).
  • specs/001-codespace-xml-scaffold/plan.md — the implementation plan.
  • specs/001-codespace-xml-scaffold/data-model.md — entities and field rules.
  • specs/001-codespace-xml-scaffold/contracts/ — the CLI and pipeline contracts.

Generated reference

make gen-schema-docs (re)generates the schema reference from the enriched XSD — the entity tables, every field's xs:documentation prose, and the Mermaid ERD — produced from the schema so they cannot drift (ADR 0009). The committed page is regenerated by CI; a stale copy fails the drift gate.