Research references¶
This guide uses the following five public documentation sources. The content below is original Themis guidance. It does not copy their text.
1. MkDocs User Guide¶
MkDocs User Guide and Deploying Your Docs
We used the MkDocs model of Markdown source, one YAML configuration file,
explicit navigation, a build directory, and static hosting. This is why the
Themis docs build is separate from the application container and is served as
static files below /themis/docs/.
2. Material for MkDocs¶
Material for MkDocs and its built-in search documentation
We used a clear section structure, responsive navigation, local search, code copy buttons, and dark-mode support. The site does not depend on a third-party runtime search service.
3. OpenTelemetry¶
OpenTelemetry documentation and OpenTelemetry Concepts
We used the distinction between traces, spans, context propagation, and the three telemetry signal types. The Themis guide applies that distinction to release evidence. It does not confuse a runtime trace with a release decision.
4. DataHub¶
DataHub documentation and DataHub lineage tutorial
We used the idea that a catalog can provide schema, ownership, lineage, quality, and governance context. The Themis guide treats missing metadata as an evidence gap and keeps DataHub separate from SQL execution.
5. Great Expectations¶
Great Expectations Core overview
We used the pattern of defining explicit expectations, validating a batch, and recording a result that people can inspect. Themis applies a related pattern to replay cases and independent oracles. The two projects are different systems; Themis does not claim to be Great Expectations.
Writing choices¶
The pages use short sentences, direct verbs, stable terms, and one instruction per step. This follows the goal of ASD-STE 100: make technical instructions clear for readers who do not share the author's background.