docs: sort the top-level directories into five sections by what the reader wants
Every docs directory moves under 1-getting-started, 2-handbook, 4-implementation or 5-project; the options reference (section 3) comes from the website and has no directory here. trust-boundary stays whole under the handbook for now. web-ui, swarm and tools split between handbook and implementation, and the command-line references move to 2-handbook/reference. Links, path references in code and nix, and the docs index follow the moves; no page content changes.
This commit is contained in:
parent
53ccbcb4b3
commit
6739bb903d
2 changed files with 736 additions and 701 deletions
|
|
@ -138,7 +138,7 @@ fn app(coord: Arc<Coordinator>) -> axum::Router {
|
|||
|
||||
pub async fn serve(port: u16, coord: Arc<Coordinator>) -> Result<()> {
|
||||
// Binds loopback-only; external access via gateway.
|
||||
// Rationale: docs/networking/gateway.md::Firewall posture.
|
||||
// Rationale: docs/4-implementation/networking/gateway.md::Firewall posture.
|
||||
let addr = SocketAddr::from(([127, 0, 0, 1], port));
|
||||
let listener = bind_with_retry(addr).await?;
|
||||
tracing::info!(%addr, "dashboard listening");
|
||||
|
|
@ -146,10 +146,10 @@ pub async fn serve(port: u16, coord: Arc<Coordinator>) -> Result<()> {
|
|||
Ok(())
|
||||
}
|
||||
|
||||
// SPA shape + SSE channels: docs/web-ui/shape.md.
|
||||
// SPA shape + SSE channels: docs/4-implementation/web-ui/shape.md.
|
||||
|
||||
/// `SO_REUSEADDR` bind with retry. Retry mechanics, attempt-cap
|
||||
/// rationale, and log-level cadence: `docs/web-ui/shape.md::Listener bind`.
|
||||
/// rationale, and log-level cadence: `docs/4-implementation/web-ui/shape.md::Listener bind`.
|
||||
async fn bind_with_retry(addr: SocketAddr) -> Result<tokio::net::TcpListener> {
|
||||
let mut retries = 0u32;
|
||||
let listener = (|| async { try_bind(addr) })
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
//! `/api/state` cold-load snapshot plus the dashboard's live read side:
|
||||
//! the `StateSnapshot` shape and its view builders, the
|
||||
//! `/api/dashboard/stream` SSE channel. SPA shape + SSE channels:
|
||||
//! docs/web-ui/shape.md.
|
||||
//! docs/4-implementation/web-ui/shape.md.
|
||||
|
||||
use std::convert::Infallible;
|
||||
|
||||
|
|
@ -64,7 +64,7 @@ pub(super) struct StateSnapshot {
|
|||
/// runtime-generated `agents.conf` include file — see
|
||||
/// `gateway_nginx.rs`). The `false` branch (direct
|
||||
/// `http://<hostname>:<port>/` TCP links) is retained as a defensive
|
||||
/// fallback for the env being unset. See `docs/networking/gateway.md::Vhost map`.
|
||||
/// fallback for the env being unset. See `docs/4-implementation/networking/gateway.md::Vhost map`.
|
||||
gateway_enabled: bool,
|
||||
/// Public URL of the forge (e.g.
|
||||
/// `"https://forge.pr1ma.darkest.space"`). Sourced from the
|
||||
|
|
|
|||
Loading…
Reference in a new issue