Skip to content

Omnist documentation

This folder is the source for the VitePress docs site (docs.yml deploys it to GitHub Pages on push to master). Start here, in roughly this order:

DocWhat it covers
QuickstartThe shortest possible tour.
User guideThe practical tour -- documents, OML, OSD and the builder functions, validation, the schema operations, codecs, inference.
The Schema model & OSDrecord definitions, cardinality, the builder functions, and the comparison/inference operations.
A real-life exampleOne order schema validated against an order written in OML.
API referenceEvery public name with signatures.
CLIThe omnist command-line tool.
FormatsHow each format maps to the model -- OML / JSON / YAML / TOML / XML.
Model specThe formal definitions of the Document and Schema models.
OML-Core grammarThe formal ABNF grammar for OML.
OSD grammarThe formal ABNF grammar for OSD.
The any typeThe formal spec for any-typed fields.
OpennessThe design note on schema openness, deferred beyond v1.0.
GlossaryOne definition per term used across the docs and code.
TestingThe test suite: layout, coverage tooling and target, fuzzing, the semantic oracle, and the doc-example CI gate.
Repo layoutHow the repo is organized: src/*.ts responsibilities, the docs page map, the test file map.