Brummel
cb82987c33
The first runnable DocSite server (plan docs/plans/0001-walking-skeleton.md):
`docsite serve` renders the published docs of aura and data-server live from
their Gitea main revisions, dark-themed, navigated from the DocSite-owned
whitelist registry; `docsite check` validates every nav reference against the
live sources with an exit code. Built across nine TDD tasks — config (registry
whitelist + traversal guard), gitea read-only client (Fetcher trait, injected
for offline tests), render (comrak GFM + syntect), theme (embedded dark CSS +
shell), revision-keyed cache, reference validator, axum server, main wiring.
All five domain invariants land: read-only Gitea access via the Fetcher trait;
single source of truth via the (repo,path,sha) cache; reference integrity
detected (check + a fail-loud render-time error block) never enforced;
whitelist publishing with path-traversal refusal; the closed directive
vocabulary's no-op expansion seam reserved in render.
Verification (run by the orchestrator): cargo build green; cargo test green —
40 tests (32 lib unit + 7 e2e via an injected MockFetcher + 1 gated live smoke
that reached the real Gitea this run); cargo clippy --all-targets -D warnings
clean.
Held quality findings (plan-prescribed / plan-deferred, not defects; tracked
as follow-up issues): nav_html interpolates the registry slug/page into the
href unescaped (operator-trusted registry — latent, not a live vector);
GiteaClient's 404->NotFound status mapping (the invariant-3 broken-reference
signal) is covered only by the gated live smoke's happy path, not a unit test.
Resolved API deviations from the plan text (newer crate versions): reqwest
0.13 renamed feature rustls-tls -> rustls; comrak 0.52 deprecated `Plugins`
(used `comrak::options::Plugins`); axum 0.8 capture syntax `/{slug}/{*page}`.
refs #1
18 lines
508 B
TOML
18 lines
508 B
TOML
[package]
|
|
name = "docsite"
|
|
version = "0.1.0"
|
|
edition = "2021"
|
|
description = "Single-source-of-truth LAN documentation server"
|
|
|
|
[dependencies]
|
|
axum = "0.8.9"
|
|
comrak = "0.52.0"
|
|
reqwest = { version = "0.13.4", default-features = false, features = ["blocking", "rustls"] }
|
|
serde = { version = "1.0.228", features = ["derive"] }
|
|
syntect = "5.3.0"
|
|
tokio = { version = "1.52.3", features = ["rt-multi-thread", "macros", "net"] }
|
|
toml = "1.1.2"
|
|
|
|
[dev-dependencies]
|
|
tower = { version = "0.5.3", features = ["util"] }
|