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
1 changed files with 736 additions and 701 deletions
|
|
@ -94,8 +94,8 @@ fn routes() -> Router<AppState> {
|
|||
///
|
||||
/// `HIVE_WEB_SOCKET` opt-in selects unix-socket vs TCP binding; the
|
||||
/// dual-mode transition + gateway-side consumer live in
|
||||
/// `docs/web-ui/shape.md::Listener bind` and
|
||||
/// `docs/networking/gateway.md::Per-agent unix-socket upstream`.
|
||||
/// `docs/4-implementation/web-ui/shape.md::Listener bind` and
|
||||
/// `docs/4-implementation/networking/gateway.md::Per-agent unix-socket upstream`.
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
|
|
@ -150,7 +150,7 @@ pub async fn serve(
|
|||
// `UnixListener` at the given path. Empty string treated as
|
||||
// unset so a stray `HIVE_WEB_SOCKET=` doesn't trap us into an
|
||||
// un-bindable empty path. Falls through to the TCP path below
|
||||
// otherwise. See docs/networking/gateway.md::Per-agent unix-socket upstream
|
||||
// otherwise. See docs/4-implementation/networking/gateway.md::Per-agent unix-socket upstream
|
||||
// for the gateway-side consumer.
|
||||
if let Some(socket_path) = std::env::var_os("HIVE_WEB_SOCKET")
|
||||
&& !socket_path.is_empty()
|
||||
|
|
@ -181,7 +181,7 @@ pub async fn serve(
|
|||
/// to ask.
|
||||
///
|
||||
/// Marker-gating + the gateway-side consumer: see
|
||||
/// `docs/networking/gateway.md::Per-agent unix-socket upstream`.
|
||||
/// `docs/4-implementation/networking/gateway.md::Per-agent unix-socket upstream`.
|
||||
fn bind_unix(path: &Path) -> Result<tokio::net::UnixListener> {
|
||||
use std::os::unix::fs::PermissionsExt;
|
||||
if let Some(parent) = path.parent() {
|
||||
|
|
@ -221,7 +221,7 @@ const MAX_BIND_ATTEMPTS: u32 = 12;
|
|||
/// not an unbounded wait).
|
||||
///
|
||||
/// Retry rationale + dashboard-banner-on-real-collision:
|
||||
/// see `docs/web-ui/shape.md::Listener bind`.
|
||||
/// see `docs/4-implementation/web-ui/shape.md::Listener bind`.
|
||||
async fn bind_with_retry(addr: SocketAddr, label: &str) -> Result<tokio::net::TcpListener> {
|
||||
let mut retries = 0u32;
|
||||
let bound = (|| async { try_bind(addr) })
|
||||
|
|
|
|||
Loading…
Reference in a new issue