Documentation Status Matrix
This matrix shows whether each major documentation area describes implemented
behavior, partially implemented behavior, planned work, or pre-release channel
state. Use it with the documentation channel guide: dev
documentation may describe current main branch behavior and roadmap context,
while stable documentation is reserved for release or version-tag builds and
may not exist before the first release.
Status Definitions
| Status | Meaning |
|---|---|
| Implemented | The documented behavior exists in the Rust workspace and has a validation path. |
| Partial | Some documented behavior exists, but important user-facing surfaces or workflows remain incomplete. |
| Planned | The page documents intended contracts or roadmap work that should not be treated as finished behavior. |
| Pre-release | The documentation channel or release-facing surface exists as direction, but a first stable release may not exist yet. |
Matrix
| Area | Documentation status | Reader guidance | Pages | Backlog or issue context |
|---|---|---|---|---|
| Architecture | Implemented | Treat the crate boundaries, adapter ownership, workflow ownership, governance, provenance, and bounded web control-plane boundary as current architecture. Full host-language bindings remain partial. | System Architecture, Web Control Plane, Adapters And Runtime Boundaries, Governance And Provenance | P0.5 crate skeleton, P0.7 core domain types, P0.8 domain ports and policies, web control-plane documentation issue |
| Data contracts | Implemented | Arrow RecordBatch, Parquet, and Arrow IPC are implemented crate-boundary contracts. The local schema registry now covers broad JSON control-plane payload families while preserving Arrow IPC and Parquet as data-plane contracts. | Data Contracts, Binding Contracts And Roadmap, Control Plane, Daemon, And CLI Status | P0.4 tabular contract, P1.7 Arrow and Parquet boundary layer, P1.16 JSON schemas |
| HDSS CLI workflow | Implemented | The HDSS workflow is documented as a daemon/session-backed CLI command sequence. The former standalone example binary has been removed in favor of the public CLI surface. | HDSS CLI Workflow, Example Workflows | CLI productization issue 12, P1.18j CLI QA output and HDSS workflow usability gaps, P2.3 entity and relation linking |
| REDCap import | Implemented | Offline roles and both client/Trusted live API acquisition are qualified through CLI/C. Fresh tokens use a separate transient sensitive channel; legacy dotenv/token-env ingestion remains removed. | Importing A REDCap Project, Example Workflows | P2.1 REDCap ingest |
| CLI | Implemented | The Rust CLI exposes local inspection, configuration and Secret administration, Managed-runtime lifecycle, Session and Datastore operations, semantic catalog, Study/governance, asset, datafile, dataset, entity/relation, ingest, and transformation command groups. Use the CLI reference for the command inventory and schema list/get for the implemented JSON control-plane schema catalog. | Control Plane, Daemon, And CLI Status, Rust CLI Reference, CLI How-To | P1.16 JSON schemas, P1.18 CLI foundation, CLI readiness PRD |
| Daemon | Partial | The daemon crate has implemented local lifecycle commands, daemon-backed version and doctor readiness probes, named session state, selected-session metadata, current-study state, and broad protocol dispatch into app workflows. It remains partial because the daemon is still a local process rather than the final HTTP control plane, and broader release-hardening and protocol evolution work remains. | Control Plane, Daemon, And CLI Status | P1.17 local daemon protocol and session model, local issue 10 |
| Web control plane | Partial | The deployed HTTP service implements browser-safe discovery, ORCID browser sessions, study access-request lifecycle, readiness, diagnostics, and limited protocol diagnostics. Substantive operations use the authenticated Trusted-runtime route; Web has no direct datastore authority. It is not the local daemon, does not deliver protected data content, and does not include the separate TypeScript frontend product. | Web Control Plane, Web deployment security, frontend fixtures | web control-plane PRD, Trusted-runtime routing PRD, issue 20 frontend handoff |
| Bindings | Partial | The C ABI is implemented as the first stable generic protocol adapter, with startup introspection, immutable Client bootstrap selection, authenticated Trusted-runtime protocol execution, opaque client/session/result handles, response JSON access, optional payload access, and ownership cleanup rules. ADR-0005 moves full Python, Julia, and R package implementation to external repositories; this workspace owns their runtime contract, seed handoff, compatibility fixtures, and transitional scaffold crates. | Stable C ABI, Binding Contracts And Roadmap, Binding Repository Seed Contract, Data Contracts | P1.21 stable C ABI, P2.8 Python binding repository handoff, P2.9 Julia binding repository handoff, P2.10 R binding repository handoff, local issue 11 |
| Documentation channels | Pre-release | Use dev for current main-branch documentation and roadmap context. Use stable only for release/tag documentation; it may be absent before the first release. | Documentation Channels, Overview | P2.11 release matrix, publish docs PRD |
Channel Choice
Use dev when you need the latest documented repository behavior, current
workflow status, or roadmap notes for partial and planned surfaces such as the
local daemon, the bounded web control plane, and language bindings.
Use stable when you need documentation that matches a release or version tag.
Before the first release, the stable channel may be missing; in that case, read
the dev channel and check the matrix status before relying on incomplete
surfaces as operator-facing behavior.