Minimum viable documentation for TROV 0.1

[tmcphillips]

Summary

Minimum viable documentation for adopters to produce and consume TRO declarations using TROV 0.1

Includes developer-facing documentation for the TRACE specification, TROV vocabulary, and TRO declaration format. Documents are plain GitHub-Flavored Markdown, built and served via Jupyter Book, and available for download as Markdown and PDF.

Published at: https://transparency-certified.github.io/trace-specification/

Documents

Published

• TRO Declaration Format — structure and field reference for TRO declarations
• TRO Declaration Design — why TRO declarations use JSON-LD
• TROV Vocabulary Reference — term reference for all classes, properties, and named individuals
• TROV Extension Guide — how to add institution-specific terms
• TROV Versioning Strategy and Roadmap — version numbering, namespace scheme, roadmap
• TROV Pre-Release Reference — frozen snapshot of the pre-release vocabulary with migration guidance
• Documentation Infrastructure — how the documentation is built and deployed

Planned

• TRO Packages — ZIP layout, signing files, signing mechanism flexibility
• TRS Profile Format — how a TRS declares identity, capabilities, signing key
• Conceptual Model — expansion of currently very terse document using prose distilled from Li et al. 2025
• Implementing a TRS — guide for teams building TRACE-compatible systems
• Confidential Artifact Protection — HMAC-based hashing for low-entropy artifacts
• Glossary — comprehensive definitions of TRACE terms, acronyms, and concepts with linkable targets

Infrastructure

• w3id.org namespace registered (Register w3id.org/trace namespace #13)
• trace-vocabularies repo created (Create trace-vocabularies repo to serve as hub for TRACE vocabularies #20)
• Automatic build and deploy of Widoco docs for all vocabulary versions
• TROV 0.1 vocabulary files resolve via w3id.org/trace/trov/0.1 with content negotiation
• Pre-release vocabulary files resolve via w3id.org/trace/2023/05/trov
• Vocabulary index page (Create vocabulary index page #15)
• Widoco workflow enhancements (Update Widoco build and deployment workflow #16)
• Short-name anchors for term-level URIs (Add short-name anchors to Widoco HTML output #17)
• Whole-book PDF Jupyter Book build for download and inclusion in tagged releases
• Update TROV 0.1 ontology files to match documentation (Update TROV 0.1 ontology files to match documentation #19)

Related

• Create trace-vocabularies repo to serve as hub for TRACE vocabularies #20