Architecture

Workspace Layout

The UOR Framework is a Rust workspace with seven member crates:

Dependency Order

uor-ontology (spec/)
  ↓ Ontology::full()
  ├── uor-build      → public/uor.foundation.{json,ttl,nt}, uor.term.ebnf
  ├── uor-docs       → public/docs/                           (documentation export)
  ├── uor-website    → public/                                 (website export)
  ├── uor-crate      → foundation/src/                         (Rust export)
  └── uor-conformance → validates all of the above

spec/ Library (uor-ontology)

uor-ontology encodes the complete ontology as typed Rust static data:

• model.rs: Core types — Namespace, Class, Property, Individual, Ontology
• namespaces/*.rs: 33 modules, one per namespace (all 95 amendments applied)
• serializer/jsonld.rs: Serializes to JSON-LD 1.1
• serializer/turtle.rs: Serializes to Turtle 1.1
• serializer/ntriples.rs: Serializes to N-Triples

The entry point Ontology::full() uses OnceLock for thread-safe lazy initialization.

This crate is the single source of truth. It is internal (publish = false).

codegen/ Library (uor-codegen)

uor-codegen generates the published Rust trait crate from the ontology:

• mapping.rs: Namespace → module, XSD → Rust type, class IRI → path tables
• traits.rs: Class → trait, property → method generation
• enums.rs: Enum detection (PrimitiveOp, MetricAxis, Space, SiteState, ExecutionPolicyKind, GeometricCharacter, VerificationDomain, ComplexityClass, RewriteRule, MeasurementUnit, TriadProjection, SessionBoundaryType, PhaseBoundaryType, GroundingPhase, AchievabilityStatus, ValidityScopeKind, ProofModality) and WittLevel newtype struct generation
• individuals.rs: Named individual → const module / PrimitiveOp impl generation
• emit.rs: Rust source code writer

foundation/ Library (uor-foundation)

uor-foundation is the generated published crate. Every file in foundation/src/ is produced by uor-crate — never hand-edited.

• 423 traits (one per OWL class, generic over Primitives)
• 856 methods (one per property with a domain)
• 18 enums (Space, PrimitiveOp, MetricAxis, SiteState, ExecutionPolicyKind, GeometricCharacter, VerificationDomain, ComplexityClass, RewriteRule, MeasurementUnit, TriadProjection, SessionBoundaryType, PhaseBoundaryType, GroundingPhase, AchievabilityStatus, ValidityScopeKind, ProofModality) + 1 struct (WittLevel)
• 1501 constant modules (for named individuals)
• Zero mandatory dependencies — pure traits

Module structure: kernel/ (17 namespaces), bridge/ (13 namespaces), user/ (3 namespaces).

conformance/ Library

uor-conformance is the workspace quality gate. It validates:

1. Rust source: API documentation, style conventions
2. Ontology artifacts: JSON-LD 1.1, OWL 2 DL constraints, RDF 1.1, Turtle 1.1, inventory counts
3. SHACL instances: 276 test graphs validated against 441 NodeShapes
4. Generated crate: Trait completeness, method completeness, individual completeness
5. Documentation: Diataxis structure, completeness, accuracy, links
6. Website: HTML5, WCAG 2.1 AA, CSS, coverage, links

The conformance suite is the single gate — all components must pass before a release.

docs/ Library

uor-docs generates documentation with enforced accuracy:

• Namespace reference pages are 100% auto-generated from uor_ontology::Ontology::full()
• Prose pages use {@class}, {@prop}, {@ind} DSL, validated at build time
• Every spec term must appear in at least one page (completeness check)

website/ Library

uor-website generates the static site at https://uor.foundation/:

• Templates use the Tera template engine
• Namespace pages are auto-generated (no hand-written HTML for spec terms)
• Search index is generated from all 441 classes, 891 properties, 3356 individuals
• No external dependencies (no CDN, no tracking, no third-party scripts)

Build Pipeline

cargo run --bin uor-build       → public/uor.foundation.{json,ttl,nt}
cargo run --bin uor-crate       → foundation/src/ (generated Rust traits)
cargo run --bin uor-docs        → public/docs/ + README.md
cargo run --bin uor-website     → public/ (HTML, CSS, JS, search-index.json)
cargo run --bin uor-conformance → validates all of the above

Amendment History

The spec crate implements all 95 amendments from the UOR Foundation completion plan: