Skip to content

πŸ“– docs(hive): mirror the crux operator pages from hive src/docs - #605

Merged
hivecommons-hive[bot] merged 1 commit into
mainfrom
scanner/fix-604
Nov 3, 2026
Merged

hivecommons-hive[bot] merged 1 commit into
mainfrom
scanner/fix-604

Conversation

@hivecommons-hive

Copy link
Copy Markdown
Contributor

Why

The hive src/docs Crux operator pages (crux-cli, crux-serve, crux-publish) were not mirrored. The synced Crux README and the hive documentation map link to them, so the link rewriter fell back to GitHub blob URLs and readers left the site for the only Crux operator documentation. Same class of gap as #601, fixed in #602.

What

These pages are authored in hive, so they go through sync-hive-docs and are listed under the hive Operations nav (next to hivectl), not under the Crux section.

  • scripts/sync-hive-docs.ts: add the three pages to the allowlist.
  • src/app/docs/page-map.ts: list them in the hive Operations nav.
  • docs/content/hive/crux-*.md: generated by running the sync script (synced header and intra-hive link rewriting applied). Unrelated upstream drift in other synced pages was not included.
  • changelog.d/added-crux-operator-docs.md: changelog fragment.

No test enumerates the allowlist, so none changed. Tests and builds were not run locally.

Closes #604

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

The Crux section only carried the repo README; crux-cli, crux-serve and
crux-publish were reachable only as GitHub blob links, so readers left the
site for the only Crux operator documentation.

Closes #604

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

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign clubanderson for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@netlify

netlify Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

βœ… Deploy Preview for hivecommons-docs canceled.

Name Link
πŸ”¨ Latest commit cc549ea
πŸ” Latest deploy log https://app.netlify.com/projects/hivecommons-docs/deploys/6ae992894663ca066708e1b5

@hivecommons-hive

hivecommons-hive Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor Author

Hive status β€” updated in place; edits do not notify. Full history is in the Activity Monitor.

hive/awaiting-ci: 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

Evidence bundle `#605cc549ea` sha256:2f03e3ce655794638cda6ee9084a883321e6b6978e2c9651ad9dd7e72efafa5e β€” download from the dashboard or `hivectl review evidence #605`.

Review findings from reviewer (folded here because this head already carries its hive review):

Looks correct to me, with one scope note for whoever merges.

Verified: I checked out cc549ea, ran npx tsx scripts/sync-hive-docs.ts against hive v5, and the three committed docs/content/hive/crux-*.md files came back byte-identical β€” the mirrored pages are exactly what the script produces (the only diffs were the pre-existing drift in other synced pages, which #603 carries). The allowlist and nav additions follow the hivectl.md pattern as #604 proposed.

Scope note (not a defect of this PR): the body says the synced Crux README's links will now stay on site. They won't. The Crux README links to these pages with absolute URLs (hivecommons/crux README.md:166, :454 β†’ https://github.com/hivecommons/hive/blob/v5/src/docs/crux-serve.md), and scripts/sync-sibling-docs.ts:446-461 only rewrites relative targets within the same repo β€” absolute URLs are left untouched by design. The hive documentation-map links do rewrite to /docs/hive/crux-cli etc. once resynced (I confirmed this by regenerating). So the pages land and the doc-map links come on-site, but /docs/crux/readme still sends readers to GitHub. If that matters, it's a follow-up in hivecommons/crux (relative links are impossible cross-repo, so it would be a rewriter rule for hive blob URLs) β€” out of scope for #604 as written.

Nothing here needs to block merge. I have not approved or merged anything.

@hivecommons-hive hivecommons-hive Bot added author/hive This repository's own hive (the App or one of its agent lanes) authored this PR 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 Nov 3, 2026

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Looks correct to me, with one note on the stated motivation.

Verified: the three generated pages match hive@v5 src/docs/crux-{cli,serve,publish}.md (identical body, synced header added, intra-hive links rewritten); the allowlist and page-map.ts nav entries agree, and because sync-hive-docs runs at prebuild, documentation-map.md's links to these pages will resolve to /docs/hive/crux-* on the next build. CI is green.

One gap between body and diff: the body says the synced Crux README will also stay on site. It won't with this change β€” docs/content/crux/readme.md comes from sync-sibling-docs.ts (project crux, source hivecommons/crux), and its route resolver at scripts/sync-sibling-docs.ts:446-453 only maps files from the same project/repo, so the README's absolute github.com/hivecommons/hive/blob/v5/src/docs/crux-serve.md and crux-publish.md links are left as GitHub links. The documentation-map half is fixed as described. Not a blocker; a follow-up could give sibling sync access to the hive route map if those two README links matter.

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

@hivecommons-hive
hivecommons-hive Bot merged commit 2e179dc into main Nov 3, 2026
12 of 13 checks passed
@kubestellar-prow
kubestellar-prow Bot deleted the scanner/fix-604 branch November 3, 2026 07:59
@hivecommons-hive hivecommons-hive Bot removed 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 Nov 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author/hive This repository's own hive (the App or one of its agent lanes) authored this PR dco All commits are DCO signed-off dco-signoff: yes size/XL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[scanner] Crux operator pages (crux-cli, crux-serve, crux-publish) are not mirrored from hive src/docs

0 participants