07b62612b0
Per mara's go-ahead on hyperhive#3902 ("getting started is good, but
terminal rendering does not go in there i think"):
Moved 21 top-level docs/*.md files into 7 new topic subdirectories
(existing web-ui/, turn-loop/, swarm/, tools/, crates/ untouched):
getting-started/ setup.md
agent-lifecycle/ agent-hierarchy.md, approvals.md, persistence.md
trust-boundary/ boundary.md, security.md
integrations/ forge.md, matrix.md, github.md, knowledge.md
networking/ gateway.md, network.md, snapshot-store.md
scheduler/ jobq.md, coordinator.md, ci.md, observability.md
process/ conventions.md, gotchas.md, pr-review-gate.md
web-ui/ terminal-rendering.md (moved into the EXISTING dir,
per mara's correction to the original getting-started
guess -- it's UI implementation detail, not onboarding)
The physical layout now matches docs/README.md's own topical headers,
which already amounted to this taxonomy -- see the scoping comment on
the issue for the two findings that motivated this (a genuine
duplication between CLAUDE.md's old "Reading paths" list and
docs/README.md's grouped one, since drifted out of sync with each
other; and the flat layout not matching the grouping we already had).
Fixed every cross-reference this moved across the whole repo (~120
files: docs/ internal links at every depth, Rust doc comments, nix
module option docs, crate READMEs) -- verified two ways: a grep sweep
confirming zero remaining references to any old path, and a script
that resolves every markdown link in docs/**/*.md + CLAUDE.md +
README.md against the filesystem and reports anything that doesn't
exist (zero broken links).
Collapsed CLAUDE.md's "Reading paths" section (the duplicate) down to
a pointer at docs/README.md, now the single index. Rewrote
docs/README.md itself to use the new subdirectory paths and added the
one doc it was missing that CLAUDE.md's old copy had (pr-review-gate.md).
Classified all 22 docs/*.md files first via a haiku subagent (mara's
suggestion) on two axes -- proposed grouping and operator-vs-
implementation focus -- before finalizing the taxonomy; spot-checked
the report and found internal inconsistencies (its classification
table disagreed with its own summary section for a few files), so this
taxonomy is my original proposal + the one correction mara gave
directly, not a blind application of the subagent's table. The
operator-focus data it gathered is still useful for a follow-up
content pass (docs skewing 'mixed' rather than pure operator-facing),
not addressed in this PR -- structure only.
nix fmt clean, both pre-push lints clean.
43 lines
1.9 KiB
Rust
43 lines
1.9 KiB
Rust
//! Vocabulary hive-c0re's job queue shares with its clients: what a
|
|
//! permission change carries ([`PermPayload`]) and the scheduler's
|
|
//! lifecycle [`State`].
|
|
//!
|
|
//! A `Source` enum lived here too — where a job came from, rendered as the
|
|
//! "why" chip. It was a field on the DAG container, and it went with it: a
|
|
//! job is its nodes now, and a node says what it does rather than who asked
|
|
//! for it.
|
|
//!
|
|
//! **The typed `DagView`/`NodeView` projection that used to live here is
|
|
//! gone.** One graph is served one way now — `hive_jobq_wire`'s generic
|
|
//! `GraphNode`, over the `QueueNodes` socket request and
|
|
//! `GET /api/jobq/graph` — so there is no second shape to keep in
|
|
//! agreement with the first. Queue internals (node kinds, edges,
|
|
//! scheduling) live in `hive-c0re::job_queue`.
|
|
//! Semantics: `docs/scheduler/coordinator.md::Job queue`.
|
|
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
pub use hive_jobq::State;
|
|
|
|
/// Kind-specific payload for `Template::PermChange` DAGs.
|
|
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
|
#[serde(tag = "type", rename_all = "snake_case")]
|
|
pub enum PermPayload {
|
|
/// Set the tool groups for one agent (`tool-groups.json`).
|
|
ToolGroups { groups: Vec<String> },
|
|
/// Set the capabilities for one agent (`capabilities.json`).
|
|
Capabilities { caps: Vec<String> },
|
|
/// Set both perm-types in one entry — the batch
|
|
/// `POST /api/permissions` path. `None` leaves that file untouched;
|
|
/// present fields commit together and rebuild once.
|
|
Combined {
|
|
groups: Option<Vec<String>>,
|
|
caps: Option<Vec<String>>,
|
|
},
|
|
}
|
|
|
|
/// Node id. Carries the scheduler crate's globally-monotonic node id
|
|
/// (`hive_jobq::NodeId`) verbatim on the wire — unique across all DAGs, not
|
|
/// just within one. Consumers treat it opaquely (grouping + dep matching),
|
|
/// so the widening from the old dag-local `u32` is transparent.
|
|
pub type NodeId = u64;
|