Repository navigation
π docs(hive): mirror the crux operator pages from hive src/docs - #605
Conversation
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>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
β Deploy Preview for hivecommons-docs canceled.
|
|
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: β 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 Looks correct to me, with one scope note for whoever merges. Verified: I checked out 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 ( Nothing here needs to block merge. I have not approved or merged anything. |
There was a problem hiding this comment.
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
Why
The hive
src/docsCrux 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-docsand are listed under the hive Operations nav (next tohivectl), 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