Development
azdocs is a Cargo workspace containing the CLI/shared library and Tauri backend. Install the source-build prerequisites first. Run these commands from the repository root:
cargo fmt --all --check
cargo clippy --workspace --all-targets --locked -- -D warnings
cargo test --workspace --locked
cd desktop
pnpm install --frozen-lockfile
pnpm run lint
pnpm run typecheck
pnpm test
pnpm run buildFor CLI-only work, cargo test --locked and
cargo clippy --all-targets --locked -- -D warnings target the root package.
Workspace commands also require the Tauri system libraries. Tests use synthetic
fixtures and mocked HTTP; they do not need an Azure account. Native credential
and screenshot smoke tests are separate; see Testing.
For intentional golden changes, install cargo-insta with
cargo install cargo-insta --locked, then use cargo insta review.
Generated contracts and documentation checks are described in Testing.
| Page | Covers |
|---|---|
| Architecture | Modules, data flow, design decisions and offline boundaries |
| Desktop map | Topology ownership, scope layouts, connectors, labels and cameras |
| Website screenshots | Endpoint discovery, isolated native capture, saved evidence and offline exports |
| Data model | SQLite schema, migrations and snapshot diffing |
| Azure display metadata | Friendly Azure values and the Microsoft refresh flow |
| Testing | Test layers, fixture estate, goldens and documentation checks |
| Contributing | Recipes, style and crate gotchas |
| Releasing | Version gates, signed bundles, GitHub Releases and Homebrew publishing |
Project policies: Contributing, Security, MIT licence and Third-party notices.