Skip to content

πŸ“– docs: make Hive guides easier to follow - #15282

Merged
hivecommons-hive[bot] merged 5 commits into
v5from
docs/readability-20261028
Oct 29, 2026
Merged

hivecommons-hive[bot] merged 5 commits into
v5from
docs/readability-20261028

Conversation

@clubanderson

@clubanderson clubanderson commented Oct 29, 2026 •

Copy link
Copy Markdown
Member

Rework the first-use and contributor paths, separate task instructions from reference and history, define unfamiliar terms, and reconcile contradictory policy, configuration and dashboard explanations against the current implementation. Preserve permission limits, recovery warnings, exact commands and existing anchors. Covers 55 canonical Hive documentation pages; locally maintained site pages are handled in the docs repository. No product-code changes. Pre-commit review completed, including correction and re-review of two cross-guide inconsistencies. Validation: all relative links and anchors under src/docs resolve; repo-local source citations verified; all existing readability gates pass. Includes the latest v5 changes.

Signed-off-by: Andrew Anderson <andy@clubanderson.com>
Signed-off-by: Andrew Anderson <andy@clubanderson.com>
@kubestellar-prow kubestellar-prow Bot added the dco-signoff: yes Indicates the PR's author has signed the DCO. label Oct 29, 2026
@hivecommons-hive

Copy link
Copy Markdown
Contributor

@clubanderson is auto-promoted for contributor-lane merging on this PR: the last 5 merged PRs by this author in this hive's repositories have no revert or sentinel-alert evidence. CI, reviewer verdict, diff fences, soak, holds and branch protection still apply.

@kubestellar-prow kubestellar-prow Bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 29, 2026
@hivecommons-hive hivecommons-hive Bot added author/human A person pushed this PR themselves dco All commits are DCO signed-off role/trusted Author is trusted for unattended merge (trusted-author role or registry/claim tier in require_tiers) stage/050-review-pending Review swarm requested; awaiting a verdict for the current head labels Oct 29, 2026
@github-actions

github-actions Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Open PR overlap check

Base branch: v5

Conflicts are checked with every PR merged onto the current tip of v5, so a PR that only needs a rebase is not reported as conflicting with its siblings.

PR Title Relation Files
#15308 ✨ feature: enqueue eligible PRs into GitHub native merge queues CONFLICT src/docs/documentation-map.md

@hivecommons-hive

Copy link
Copy Markdown
Contributor

@clubanderson this PR is held at stage/071-needs-author and the hive will not merge it yet.

Why:

  • the branch conflicts with the base and needs a rebase

Next: the hive does not push to your branch. Push a new head (or reply here); CI and the review swarm re-run automatically and the PR returns to the normal path.

@github-actions github-actions Bot removed the conflicts-with-open-pr Open PR has a merge conflict with another open PR label Oct 29, 2026
Signed-off-by: Andrew Anderson <andy@clubanderson.com>

# Conflicts:
#	src/docs/dashboard-sections.md
@github-actions github-actions Bot added the conflicts-with-open-pr Open PR has a merge conflict with another open PR label Oct 29, 2026
@hivecommons-hive hivecommons-hive Bot added stage/050-review-pending Review swarm requested; awaiting a verdict for the current head stage/071-needs-author Human-authored PR: CI red, changes requested or conflicting; diagnosis posted, the author must act and removed stage/071-needs-author Human-authored PR: CI red, changes requested or conflicting; diagnosis posted, the author must act stage/050-review-pending Review swarm requested; awaiting a verdict for the current head labels Oct 29, 2026
@hivecommons-hive

Copy link
Copy Markdown
Contributor

@clubanderson this PR is held at stage/071-needs-author and the hive will not merge it yet.

Failing checks:

  • test (dashboard 3/4)
  • test (dashboard shuffle 2/3)

Next: the hive does not push to your branch. Push a new head (or reply here); CI and the review swarm re-run automatically and the PR returns to the normal path.

Signed-off-by: Andrew Anderson <andy@clubanderson.com>
@github-actions github-actions Bot removed the conflicts-with-open-pr Open PR has a merge conflict with another open PR label Oct 29, 2026
@hivecommons-hive

Copy link
Copy Markdown
Contributor

@clubanderson this PR is held at stage/071-needs-author and the hive will not merge it yet.

Why:

  • the branch conflicts with the base and needs a rebase

Next: the hive does not push to your branch. Push a new head (or reply here); CI and the review swarm re-run automatically and the PR returns to the normal path.

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed β€” no findings from this perspective.

β€” hive: agent=ci-maintainer backend=copilot model=claude-fable-5.1 copilot=1.0.88

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed (correctness) β€” no blocking findings. Verified at head 8f73a3d: relative links/anchors (check-docs-links.py: 259 files clean), check-docs-citations.py (1285 refs), security-docs readability/rot gates, hivectl subcommands/flags in hivectl.md against src/pkg/hivectl/commands/*.go (incl. hives disable, hives list --check, tui --hives), HIVE_DASHBOARD_BIND/HIVE_DASHBOARD_COOKIE/exit‑19 claims in env-vars.md against dashboard/server.js:117, src/pkg/hivectl/session.go:30, src/cmd/hive/main.go:843.

One advisory, carried over from the base text (not a blocker): two source citations point at paths that no longer exist β€” the packages live under src/crux/.

src/docs/labels-and-control-signals.md:697

**Configuration and implementation.** `project.repo_policies[].auto_merge` (`src/pkg/config/repo_policy.go`, `src/crux/agent/manager_modes.go`, `src/pkg/github/automerge/automerge_sweep.go`, `src/crux/proxy/rules.go`)

src/docs/security-model.md:72 likewise cites src/pkg/proxy/rules.go β†’ src/crux/proxy/rules.go.

β€” hive: agent=adjudicator backend=copilot model=claude-fable-5.1 copilot=1.0.88

@hivecommons-hive

Copy link
Copy Markdown
Contributor

Hive filed review findings that do not block this PR as backlog items:

Cap: 10 backlog item(s) per PR per day.

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Intent alignment (read head 8f73a3d, all 55 files under src/docs, plus base d863146 tree). The diff matches the description: docs-only, every removed heading was moved rather than dropped (all #anchor links across src/docs still resolve), and every removed command line reappears except hivectl enroll hivecommons/hive, which became the generic hivectl enroll OWNER/REPO (src/docs/hivectl.md:910). Spot-checked soak-window wording against src/scripts/promote-stable.sh:5 β€” consistent.

One gap against the body's "repo-local source citations verified" claim (low, advisory): two paths on lines this PR rewrites point at files that no longer exist at head β€” they moved to src/crux/.

src/docs/labels-and-control-signals.md:697:

**Configuration and implementation.** `project.repo_policies[].auto_merge` (`src/pkg/config/repo_policy.go`, `src/crux/agent/manager_modes.go`, `src/pkg/github/automerge/automerge_sweep.go`, `src/crux/proxy/rules.go`)

src/docs/security-model.md:72:

| Policy proxy and repo allowlist | credential theft, out-of-scope writes | `src/crux/proxy/rules.go` | `403` with `X-Hive-Proxy-Blocked` |

(Both were already stale in base; noted only because the PR rewrites these lines and states citations were checked. The other 138 added path citations resolve.)

β€” hive: agent=adjudicator backend=copilot model=claude-fable-5.1 copilot=1.0.88

@hivecommons-hive

Copy link
Copy Markdown
Contributor

stage 080-awaiting-merge-admission: no activity for 30m0s: merge-train:queued-behind#15301:3/4:0/0:agent-configuration.md,api-reference.md,documentation-map.md,labels-and-control-signals.md

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed (style/maintainability) β€” read at head 8f73a3d.

Low β€” src/docs/README.md now presents the same three run routes twice. The new ## Get started table (README.md:10-30: hosted / self-host via ComposeΒ·PodmanΒ·Kubernetes / existing dashboard access, plus a hub-deployment.md pointer at line 30) and the retained ## Ways to run Hive section (README.md:53-56) link the same pages with near-identical wording. For a PR whose stated goal is to "separate task instructions from reference", the second copy is the kind of redundancy that drifts. Suggest dropping it:

-## Ways to run Hive
-
-- **Hosted Hive Hub:** start at [`https://hive.hivecommons.dev`](https://hive.hivecommons.dev) and follow the [hosted onboarding guide](hosted-hub.md) for the no-cluster path.
-- **Self-hosted:** run your own spoke on [Kubernetes](kubernetes-deployment.md), [Docker Compose](quickstart-docker-compose.md), or [Podman](quickstart-podman.md), or operate a [self-hosted hub](hub-deployment.md) for a fleet.
-
 ## Where to go next

Advisory (not style): tide reports a merge conflict against v5; a rebase is needed before this can land. Docs link/citation/readability gates pass on this head.

β€” hive: agent=adjudicator backend=copilot model=claude-fable-5.1 copilot=1.0.88

@hivecommons-hive

Copy link
Copy Markdown
Contributor

stage 080-awaiting-merge-admission β†’ 071-needs-author: conflicting

Port the v5 additions to the activity-monitor and labels guides (counter
semantics, rework pickup, capability-gap blockers, merge-gate legend,
post-decision state machine) into the restructured sections.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: scanner <280983584+hivecommons-hive[bot]@users.noreply.github.com>
@hivecommons-hive

Copy link
Copy Markdown
Contributor

hive/awaiting-ci: merged origin/v5 into the branch to clear the conflict in src/docs/dashboard-sections.md and src/docs/labels-and-control-signals.md (v5's new activity-monitor/labels paragraphs ported into the restructured sections). CI pending β€” sweep will merge when green.


🐝 Hive Agent: scanner | Instance: hosted-available-oke-11-placeholder-r05x | SHA: unknown

β€” hive: agent=scanner backend=copilot model=claude-fable-5.1 copilot=1.0.88

@github-actions github-actions Bot added the conflicts-with-open-pr Open PR has a merge conflict with another open PR label Oct 29, 2026

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed β€” no findings from this perspective.

β€” hive: agent=adjudicator-2 backend=copilot model=claude-fable-5.1 copilot=1.0.88

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed (intent-alignment, delta re-review at 60c40a0) β€” the delta is only the origin/v5 merge commit; no conflict markers in any merged doc, so the merge-conflict finding is resolved. Verdict for the whole PR stays approve.

Still present (low, carried from the previous review): src/docs/labels-and-control-signals.md:697 was rewritten by this PR but still cites two paths that do not exist at head β€” src/pkg/agent/manager_modes.go and src/pkg/proxy/rules.go live at src/crux/agent/manager_modes.go and src/crux/proxy/rules.go in the head tree (the other 81 src/...go citations in the file resolve). Same stale paths exist on v5, so this is pre-existing, but since the line was rewritten here it is cheap to fix:

**Configuration and implementation.** `project.repo_policies[].auto_merge` (`src/pkg/config/repo_policy.go`, `src/crux/agent/manager_modes.go`, `src/pkg/github/automerge/automerge_sweep.go`, `src/crux/proxy/rules.go`)

β€” hive: agent=ci-maintainer backend=copilot model=claude-fable-5.1 copilot=1.0.88

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delta re-review (correctness) β€” read 8f73a3d…60c40a08: the only new commit is the origin/v5 merge. I diffed the merge against both parents for every src/docs/* file: all match the base side exactly except src/docs/dashboard-sections.md, where the conflict resolution correctly re-applied the base's changes into the PR's restructured text (080/095/100 merge-gate wording at line ~1143, clanker glossary wording, relative-time + Approve & merge as maintainer toast options at ~1285). No conflict markers, no dropped hunks; PR is MERGEABLE again.

Still present (low, pre-existing in substance): src/docs/labels-and-control-signals.md:697 cites src/pkg/agent/manager_modes.go and src/pkg/proxy/rules.go; neither exists at head β€” they are src/crux/agent/manager_modes.go and src/crux/proxy/rules.go.

**Configuration and implementation.** `project.repo_policies[].auto_merge` (`src/pkg/config/repo_policy.go`, `src/crux/agent/manager_modes.go`, `src/pkg/github/automerge/automerge_sweep.go`, `src/crux/proxy/rules.go`)

β€” hive: agent=adjudicator backend=copilot model=claude-fable-5.1 copilot=1.0.88

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-currency (delta re-review at 60c40a0) β€” the delta is only the origin/v5 merge; the PR's own doc changes are unchanged, so the earlier verdict stands.

One carried-over advisory: src/docs/labels-and-control-signals.md:697 (PR-added) cites two paths that do not exist at this head β€” src/pkg/agent/manager_modes.go and src/pkg/proxy/rules.go live under src/crux/ (src/crux/agent/manager_modes.go, src/crux/proxy/rules.go). The other two citations on that line, and all 131 other src/… paths added by this PR, resolve at head; the earlier "src/pkg moved to src/crux" wording was too broad (src/pkg/github/ is still in place).

**Configuration and implementation.** `project.repo_policies[].auto_merge` (`src/pkg/config/repo_policy.go`, `src/crux/agent/manager_modes.go`, `src/pkg/github/automerge/automerge_sweep.go`, `src/crux/proxy/rules.go`)

β€” hive: agent=reviewer-2 backend=copilot model=claude-fable-5.1 copilot=1.0.88

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read at head 60c40a0 against v5 (merge-base 467ca6a). Docs-only; 55 files under src/docs, no product code. This looks correct to me on everything I could ground in the tree:

  • env-vars.md β€” the new "Proxy credential injection" section matches pkg/config/proxy_inject.go: only exact true enables (ValidateProxyInjectGHAuth, line 55), HIVE_PROXY_INJECT_GH_AUTH=true + HIVE_PROXY_ADVISORY_OK=true refuses boot, exit code 19 is proxyInjectConfigExitCode at cmd/hive/main.go:844, and other spellings are non-fatal ERROR warnings (ProxyInjectGHAuthWarnings). The prose was restructured, not changed in meaning.
  • labels-and-control-signals.md (+1089) β€” all 45 label/stage names quoted in added lines (stage/…, hive/…, needs-…, role/…, etc.) resolve to literals in Go/YAML/sh under src/.
  • hivectl.md (+717) β€” every hivectl hives <sub> / agent list / login / tui the doc now cites exists as a cobra Use in pkg/hivectl/commands/ (hives disable|enable is the constructed Use in hives.go:1011-1017).
  • dashboard-sections.md (+676) β€” the renamed Agent Logs / Confirmations / Merges / Repositories sections all exist in pkg/dashboard/static/index.html.
  • No file overlap with the other open docs PRs (#15303, #15316) at this head; the earlier conflicts-with-open-pr hold predates the v5 merge in 60c40a0.

Scope note for the maintainer: at 4.3k added lines I sampled the four largest files and the security-sensitive env reference rather than reading all 55 end to end; the link/anchor CI gate covers the rest structurally. I have not approved or changed anything.

β€” hive: agent=reviewer backend=copilot model=claude-fable-5.1 copilot=1.0.88

@hivecommons-hive
hivecommons-hive Bot merged commit b8e050d into v5 Oct 29, 2026
75 of 76 checks passed
@kubestellar-prow
kubestellar-prow Bot deleted the docs/readability-20261028 branch October 29, 2026 07:00
@hivecommons-hive

Copy link
Copy Markdown
Contributor
Evidence bundle `#1528260c40a0` sha256:127c2eafeba7e868633cd6b1f3ab48ddc0dbd30ff22041a0e0a10cbf286c7058 β€” download from the dashboard or `hivectl review evidence #15282`.

@hivecommons-hive

Copy link
Copy Markdown
Contributor

merged by Hive trusted-author auto-merge: author @clubanderson holds role owner and GitHub permission admin on repo; CI green at 60c40a0.

@github-actions

Copy link
Copy Markdown
Contributor

Thank you for your contribution! Your PR has been merged.

We'd love to hear how your experience was: share feedback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. author/human A person pushed this PR themselves conflicts-with-open-pr Open PR has a merge conflict with another open PR dco All commits are DCO signed-off dco-signoff: yes Indicates the PR's author has signed the DCO. role/trusted Author is trusted for unattended merge (trusted-author role or registry/claim tier in require_tiers) size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. stage/071-needs-author Human-authored PR: CI red, changes requested or conflicting; diagnosis posted, the author must act

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant