AHRI_TRE_RS Documentation

This book is the narrative entry point for AHRI_TRE_RS system documentation. It is published beside generated Rust API documentation so contributors can move between architecture notes and crate-level APIs without switching sites.

The first documentation slices establish the local build, publication channels, implemented architecture, adapter boundaries, governance model, provenance model, data contracts, and the Configuration and Secrets model. Start with AHRI_TRE As A Trusted Research Environment for the high-level TRE/SDE framing and Five Safes mapping. The documentation status matrix marks major areas as implemented, partial, planned, or pre-release so readers can separate current behavior from roadmap intent.

Documentation Channels

The assembled site is channel-shaped from the start:

• dev is for documentation generated from the main development branch.
• stable is reserved for release or version-tag documentation.

Local builds default to the dev channel. The stable channel is reserved for release or version-tag builds and may not exist before the first release.

Use the documentation status matrix when deciding whether a page describes stable release-facing behavior, current main-branch development behavior, or planned work that is not finished yet.

Existing Source Material

The current repository documentation remains the source of truth while the book is expanded:

• Architecture brief
• Database design
• Tabular contract
• Testing
• Ordered backlog

API Docs

The public TRE API contract is the protocol module interface. Start with the Public Protocol API guide or open the generated protocol rustdoc. Workflow implementors can still use the generated app rustdoc for the in-process application service layer.