Skip to content

Schema Documentation

Documentation for the data schema that powers this site. All entity and resource data is validated against Zod schemas at build time.

  • Diagrams - Visual documentation of entity types, relationships, and data flow
  • Validation - Run npm run crux -- validate data to check YAML files against the schema
ResourceDescription
src/data/schema.tsZod schema definitions (source of truth)
src/data/entities/*.yamlEntity data files
src/data/resources/*.yamlResource/citation data
scripts/validate/validate-yaml-schema.mjsSchema validator script
scripts/generate-schema-diagrams.mjsDiagram generator
Terminal window
# Generate all diagrams
npm run diagrams
# Schema-derived only (from Zod)
npm run diagrams:schema
# Data-derived only (from YAML)
npm run diagrams:data

Raw .mmd files are saved to internal/ (gitignored) for use in external tools.