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:
| Doc | What it covers |
|---|---|
| Quickstart | The shortest possible tour. |
| User guide | The practical tour -- documents, OML, OSD and the builder functions, validation, the schema operations, codecs, inference. |
| The Schema model & OSD | record definitions, cardinality, the builder functions, and the comparison/inference operations. |
| A real-life example | One order schema validated against an order written in OML. |
| API reference | Every public name with signatures. |
| CLI | The omnist command-line tool. |
| Formats | How each format maps to the model -- OML / JSON / YAML / TOML / XML. |
| Model spec | The formal definitions of the Document and Schema models. |
| OML-Core grammar | The formal ABNF grammar for OML. |
| OSD grammar | The formal ABNF grammar for OSD. |
The any type | The formal spec for any-typed fields. |
| Openness | The design note on schema openness, deferred beyond v1.0. |
| Glossary | One definition per term used across the docs and code. |
| Testing | The test suite: layout, coverage tooling and target, fuzzing, the semantic oracle, and the doc-example CI gate. |
| Repo layout | How the repo is organized: src/*.ts responsibilities, the docs page map, the test file map. |