Repository navigation
🌱 Remove Hive docs, point /docs/hive at its new home - #6832
Conversation
Hive was transferred out of the KubeStellar org to hivecommons and its documentation now lives at https://hive.hivecommons.dev. Publishing a second, build-time-synced copy here means docs.kubestellar.io serves stale Hive content and competes with the canonical site in search. Removed: - docs/content/hive/** (41 synced pages, including the ADR set) - scripts/sync-hive-docs.ts and its two test files, plus the prebuild step and npm script that ran it - the hive project arm: ProjectId member, PROJECTS entry, HIVE_VERSIONS, getProjectFromPath branch, NAV_STRUCTURE_HIVE, getContentPath and getBasePath cases, sidebar entry, edit/source base URLs, the HIVE_DOCS_PATH generateStaticParams block, and the stale hive entries in the generated public/config/shared.json Added: - src/app/docs/hive/page.tsx — a "Looking for Hive?" page with a button to hive.hivecommons.dev. The static segment takes precedence over the [...slug] catch-all, and the page is marked noindex so the canonical Hive docs win in search. - a permanent redirect from /docs/hive/:path+ to /docs/hive, so every existing deep link and bookmark lands on the pointer page instead of a 404. Tests updated for the removed arm; the hive-specific page-map test is deleted. Verified against a dev server: /docs/hive returns 200 and renders the pointer, /docs/hive/readme and /docs/hive/adr/* return 308 to /docs/hive, and /docs/console and /docs/introduction are unaffected. The /live/hive dashboard snapshots under public/ and the leaderboard links to them are left alone -- those are the demo dashboard, not docs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Andrew Anderson <andy@clubanderson.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 kubestellar-docs failed. Why did it fail? →
|
|
@clubanderson: The following tests failed, say
DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
There was a problem hiding this comment.
🟡 Changes recommended
The Internal Links GitHub Actions workflow still runs npm run sync-hive-docs and references scripts/sync-hive-docs.ts, which will break CI now that the script/npm target is removed.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR removes the Hive documentation subtree from the KubeStellar docs site and replaces /docs/hive with a small “Looking for Hive?” pointer page, while ensuring old deep links redirect to the pointer page instead of 404ing. It also deletes the build-time Hive docs sync pipeline and removes the Hive “project arm” wiring throughout the docs app.
Changes:
- Remove the Hive project arm (versions/config/nav/sidebar/source links) and delete the synced
docs/content/hive/**pages. - Add a dedicated
/docs/hivepointer page and a permanent redirect from/docs/hive/:path+→/docs/hive. - Remove the
sync-hive-docsbuild-time script and associated tests, and update generated shared config to drop Hive entries.
File summaries
| File | Description |
|---|---|
| src/config/versions.ts | Removes hive from ProjectId, deletes Hive versions/project config, and drops /docs/hive routing from getProjectFromPath. |
| src/components/docs/EditPageLink.tsx | Removes Hive edit-source base URL mapping. |
| src/components/docs/DocsSourceActions.tsx | Removes Hive edit-source base URL mapping. |
| src/components/docs/DocsSidebar.tsx | Removes Hive entry from primary project navigation list. |
| src/app/docs/page-map.ts | Removes Hive content/base path handling and deletes Hive nav structure and switch arm. |
| src/app/docs/hive/page.tsx | Adds /docs/hive pointer page directing users to https://hive.hivecommons.dev. |
| src/app/docs/[...slug]/page.tsx | Removes hive from known project slug handling and drops Hive static param generation from HIVE_DOCS_PATH. |
| src/app/docs/[...slug]/layout.tsx | Removes the hive slug → ProjectId mapping. |
| src/tests/versions.test.ts | Updates behavior expectations for the retired /docs/hive path. |
| src/tests/versions.shape-invariants.test.ts | Generalizes comment example now that Hive is removed. |
| src/tests/page-map-project-arms.test.ts | Updates comment now that Hive is removed from tested arms. |
| src/tests/page-map-hive-arm.test.ts | Deletes Hive-specific nav arm coverage test. |
| src/tests/page-map-getters.test.ts | Removes Hive from getContentPath/getBasePath test cases. |
| src/tests/page-map-general-section-arms.test.ts | Removes Hive from general-section arm coverage list and updates comments. |
| scripts/sync-hive-docs.ts | Deletes the Hive docs sync script. |
| scripts/sync-hive-docs.test.ts | Deletes unit tests for the removed Hive docs sync script. |
| scripts/sync-hive-docs.case-1-exact-path.test.ts | Deletes additional unit tests for the removed Hive docs sync script. |
| scripts/check-internal-links.ts | Updates script header comment to remove Hive-specific framing (but still needs adjustment per review comment). |
| public/config/shared.json | Removes stale generated Hive entries from shared config. |
| package.json | Removes sync-hive-docs script and drops it from prebuild. |
| next.config.ts | Adds permanent redirect from /docs/hive/:path+ → /docs/hive. |
| docs/content/hive/variable-substitution.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/security-threat-model.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/security-model.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/roadmap.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/release-channels.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/overview/intro.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/outreach-antispam.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/net-admin-requirement.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/macos.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/landscape.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/hivectl.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/governor.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/console-starter-install.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/architecture.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/agent-definition-yaml.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/readme.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0017-podman-quadlet-lifecycle.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0016-csp-script-src-scope.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0015-csp-style-src-scope.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0014-hub-spoke.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0013-cel-triggers.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0012-skill-registry.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0011-knowledge-system.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0010-escalation-circuit-breaker.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0009-trajectory-review.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0008-ioscan-untrusted-input.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0007-token-mint.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0006-planning-intelligence.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0005-forge-abstraction.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0004-beads-work-ledger.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0003-acmm-autonomy-levels.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0002-mitm-proxy-network-enforcement.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/adr/0001-record-architecture-decisions.md | Deletes Hive doc page (content removed from this site). |
| docs/content/hive/acmm-policy-matrix.md | Deletes Hive doc page (content removed from this site). |
Review details
- Files reviewed: 62/62 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| * WHY: Project docs are authored as markdown. A rename, a bad | ||
| * sync, or a version bump can leave a relative link pointing at a route that no | ||
| * longer exists — shipping a 404. `scripts/sync-hive-docs.ts` rewrites Hive | ||
| * longer exists — shipping a 404. The sync/authoring pipeline rewrites | ||
| * links at sync time, but nothing catches a regression at PR time. This script | ||
| * resolves every INTERNAL markdown link under `docs/content/**` against the set |
| alternates: { | ||
| canonical: '/docs/hive', | ||
| }, |
|
Thank you for your contribution! Your PR has been merged. Check out what's new:
Stay connected: Slack #kubestellar-dev | Multi-Cluster Survey |
📖 Preview LinksThe following documentation pages were changed in this PR:
|
…Projects (#7068) Both React components under src/components/docs/ have zero non-test importers: - EditPageLink.tsx (138 LOC) — sole consumer removed by #6832 (2026-09-09, 'Remove Hive docs'). Ironically received a GA4 click-telemetry update four days earlier (#6731) that now cannot fire because nothing renders the component. - RelatedProjects.tsx (398 LOC) — last non-test caller removed during the early-2026 sidebar/menu reorg (#1231, #1235). Deleting also drops their dedicated test files: - src/__tests__/EditPageLink.gtag.test.tsx (56 LOC) - src/__tests__/RelatedProjects.test.tsx (332 LOC) Total: −924 LOC / +0. No production render path is affected — the live 'edit page on GitHub' link is rendered by DocsSourceActions.tsx which is imported by DocsLayout.tsx. Closes #7067 Signed-off-by: kubestellar-hive[bot] <223556219+Copilot@users.noreply.github.com> Co-authored-by: kubestellar-hive[bot] <223556219+Copilot@users.noreply.github.com>
Summary
Hive has moved out of the KubeStellar org to its own home, and its documentation now lives at https://hive.hivecommons.dev. This removes the synced Hive docs from docs.kubestellar.io and replaces
/docs/hivewith a "Looking for Hive?" page containing a button to the new home.Keeping a build-time-synced second copy here means this site serves stale Hive content and competes with the canonical site in search results.
What this removes
docs/content/hive/**— 41 synced pages, including the full ADR setscripts/sync-hive-docs.tsand its two test files, plus theprebuildstep andsync-hive-docsnpm script that ran it on every buildhiveproject arm throughout:ProjectIdmember,PROJECTSentry,HIVE_VERSIONS, and thegetProjectFromPathbranch insrc/config/versions.tsNAV_STRUCTURE_HIVEand thegetContentPath/getBasePath/buildNavNodescases insrc/app/docs/page-map.tsDocsSidebar.tsxDocsSourceActions.tsxandEditPageLink.tsx(both pointed atkubestellar/hive, which no longer exists under that org)HIVE_DOCS_PATHblock ingenerateStaticParamsand thehiveentry inknownProjectshiveentries in the generatedpublic/config/shared.jsonWhat this adds
src/app/docs/hive/page.tsx— the "Looking for Hive?" page with a Take me to Hive button linking tohive.hivecommons.dev. The static route segment takes precedence over the[...slug]catch-all, so it wins without any special-casing. Markednoindex, followso the canonical Hive docs win in search rather than being outranked by this stub./docs/hive/:path+→/docs/hiveinnext.config.ts, so every existing deep link, bookmark, and search result lands on the pointer page instead of a 404.Verification
Type-check, lint, and the test suite were run. Two failures are pre-existing on a clean tree and unrelated to this change (confirmed by re-running against a stashed working tree): the
vitest.config.tstype error that abortsnpm run build, andMermaid.test.tsx. No new failures; the tests that asserted on the hive arm were updated or removed.Against a dev server:
/docs/hive200— renders "Looking for Hive?" with the button/docs/hive/readme308→/docs/hive/docs/hive/adr/0002-mitm-proxy-network-enforcement308→/docs/hive/docs/console/readme200— unaffected/docs/introduction200— unaffectedDeliberately out of scope
The
/live/hivedashboard snapshots underpublic/and the leaderboard links to them are left alone — that is the live demo dashboard, not documentation. Say the word if those should go too, and I will follow up separately.No other Hive Commons projects (pluk, promptargs, rationguard, hotshot) had docs on this site, so there is nothing else to remove.