API Reference (rustdoc)

Reference

Reference pages are the project's exact-facts layer. Use this category when you need accurate APIs, command entry points, architecture maps, registries, or canonical artifact locations without tutorial framing or architectural argumentation.

How to Use Reference (By Question)

If your question is...	Start here
"What does this Rust type/function/module do?"	rustdoc (see section below)
"Which crate owns this runtime or platform responsibility?"	Reference: System Architecture Map
"What diagram or visual model exists for this subsystem?"	Reference: System Diagrams
"What commands should I run for verification/docs/perf?"	Reference: Commands and Verification
"Which ADR or SOP governs this change?"	Reference: Architecture Decision Records / Reference: Operational Runbooks and SOPs
"Where is the canonical artifact stored?"	Reference: Documentation Artifact Registry

Rust API Reference (rustdoc) (Authoritative API Surface)

The authoritative Rust API reference is generated from source comments (//!, ///). Use it for crate/module/type/function behavior, invariants, error semantics, and examples.

Generate locally

cargo doc --workspace --no-deps
cargo test --workspace --doc

Open target/doc/index.html locally.

Key crates for most contributors

• site -> web entrypoints, routes, deep-link parsing
• desktop_runtime -> desktop state model, reducer/actions/effects, shell UI integration
• platform_host -> typed host-domain contracts and storage/filesystem models
• platform_host_web -> browser-facing host adapter wiring and implementations
• xtask -> local workflow orchestration and docs/perf tooling entry points

Project Reference Pages (Wiki)

• Reference: System Architecture Map
• Reference: System Diagrams
• Reference: Architecture Decision Records (ADR)
• Reference: Operational Runbooks and SOPs
• Reference: Performance Engineering and Baselines
• Reference: Commands and Verification
• Reference: Design Materials and Artifacts
• Reference: Documentation Artifact Registry

Canonical Storage Map (Source of Truth by Artifact Type)

Artifact type	Canonical storage	Access pattern
Rust APIs and code-level reference	rustdoc generated from source comments	generate locally and browse target/doc/
ADRs	docs/adr/*.md	use ADR Register
SOPs / operational runbooks	docs/sop/*.md	use Operational Runbooks and SOPs
Commands, governance references, checklists	docs/reference/*.md	use command/design/reference index pages
Diagrams and supporting assets	docs/assets/*, docs/reference/openapi/*	use System Diagrams and Design Materials and Artifacts
Reader navigation and knowledge organization	wiki/	use category pages and this reference index

Reference Category Boundary

Reference pages should remain neutral and complete. They should not substitute for:

• Tutorials (learning path)
• How-To Guides (task procedures)
• Explanations (rationale and tradeoffs)