Overview
Design principles and a reading order.
Specification
The spec/ directory is normative, and written
to be read. If the code and the specification disagree, that is a defect in
one of them.
21 documents
The specification
XML
The XML parser and its data model.
XPath 1.0
The XPath 1.0 engine: axes, functions, conversions.
XPath 2.0 subset
What is in, what is out, and where 1.0 semantics still apply.
XPath 3.0 subset
Function items, =>, ||, !, let, and the higher-order sequence functions.
Data model
Every Schematron element and its Rust type.
Parsing
The five schema compilation passes.
Validation
The validation algorithm, exactly.
SVRL
The report format, read and written.
Keys
Keys, and why a cross-reference check needs one.
Streaming validation
One repeating record at a time, in bounded memory, for schemas local to it.
Linting
Catching schemas that silently do nothing.
API
The library surface.
CLI
Every option, and every exit code.
Errors
The error taxonomy, and error versus finding.
Testing
Tests, fuzzing, benchmarks, lints.
Conformance
Limits and divergences, stated up front.
MSRV policy
Current stable minus two.
Agents directory naming
Why the agent documentation directory is lowercase.
Tutorial
Eighteen steps from one rule to a real schema.
Roadmap
Shipped, next, and not planned.
How it stays true
The documentation is machine-checked
tests/docs.rs compiles every schema shown in the docs, resolves
every relative link, and ties duplicated facts — the MSRV, the CLI flags,
the XPath function list — back to their single source. A document that
drifts from the code fails the test suite.
cargo test --all-features
cargo clippy --all-targets --all-features -- -D warnings
cargo doc --no-deps --all-features
cargo +1.96 test --all-featuresThe conformance suite lives in tests/corpus/. Each case is a
directory holding schema.sch, input.xml, and expected.txt; adding a case means adding a directory, with no
Rust to change.