Skip to content

docs: add dedicated ClawHub docs tab#79159

Merged
Patrick-Erichsen merged 5 commits into
mainfrom
pe/clawhub-docs-tab
May 8, 2026
Merged

docs: add dedicated ClawHub docs tab#79159
Patrick-Erichsen merged 5 commits into
mainfrom
pe/clawhub-docs-tab

Conversation

@Patrick-Erichsen
Copy link
Copy Markdown
Contributor

@Patrick-Erichsen Patrick-Erichsen commented May 8, 2026

Summary

  • Add a dedicated top-level ClawHub tab to the Mintlify docs navigation and move the old /tools/clawhub page to a redirect stub.
  • Mirror openclaw/clawhub:docs/** into the docs publish tree under docs/clawhub/**, while excluding ClawHub specs/**.
  • Record both OpenClaw and ClawHub source SHAs in publish metadata.
  • Update docs sync, docs link auditing, CI docs checks, localized navigation, and old ClawHub links to use the new canonical /clawhub route.

Dependency

Depends on openclaw/clawhub#2095 landing first so the ClawHub-owned docs/clawhub.md source exists on openclaw/clawhub:main before this publish pipeline starts mirroring it.

Verification

  • OPENCLAW_DOCS_SYNC_CLAWHUB_REPO=/Users/patrickerichsen/.codex/worktrees/clawhub-docs-clawhub pnpm docs:check-links
  • pnpm docs:check-mdx
  • pnpm format:docs:check
  • pnpm test src/scripts/docs-link-audit.test.ts
  • pnpm test test/scripts/barnacle-auto-response.test.ts
  • Dry-run docs sync into a temp publish tree, then MDX-check the temp tree and verify docs/clawhub/index.md exists while docs/clawhub/specs and docs/clawhub/README.md do not.
  • actionlint .github/workflows/docs-sync-publish.yml .github/workflows/ci.yml

Real behavior proof

  • Behavior or issue addressed: ClawHub-owned public docs are mirrored into the OpenClaw docs publish tree and exposed under the new top-level ClawHub docs tab, while ClawHub specs remain unpublished.
  • Real environment tested: macOS local OpenClaw worktree on Node 22+/pnpm with the paired local ClawHub worktree at pe/clawhub-docs-source-split.
  • Exact steps or command run after this patch: Ran the OpenClaw docs link audit and MDX checks with OPENCLAW_DOCS_SYNC_CLAWHUB_REPO pointing at the paired ClawHub worktree, plus a temp publish-tree dry run of scripts/docs-sync-publish.mjs and the docs-link-audit test.
  • Evidence after fix (screenshot, recording, terminal capture, console output, redacted runtime log, linked artifact, or copied live output): Copied live terminal output from the local dry run showed node scripts/docs-sync-publish.mjs syncing ClawHub docs into the publish tree, docs/clawhub/index.md present, docs/clawhub/specs absent, docs/clawhub/README.md absent, and docs/.openclaw-sync/source.json recording both OpenClaw and ClawHub source SHAs. Additional copied output: Docs MDX check passed. Test Files 1 passed (1). Tests 6 passed (6).
  • Observed result after fix: The generated docs publish tree contains the canonical ClawHub landing page at docs/clawhub/index.md, the top-bar ClawHub nav resolves, /tools/clawhub remains a compatibility redirect, and private ClawHub specs are not published.
  • What was not tested: The live Mintlify production deployment was not published from this PR; validation was local dry-run/publish-tree proof only.

@openclaw-barnacle openclaw-barnacle Bot added docs Improvements or additions to documentation scripts Repository scripts size: L maintainer Maintainer-authored PR labels May 8, 2026
@Patrick-Erichsen Patrick-Erichsen marked this pull request as ready for review May 8, 2026 01:05
@clawsweeper
Copy link
Copy Markdown
Contributor

clawsweeper Bot commented May 8, 2026

Codex review: needs maintainer review before merge.

Summary
This PR moves ClawHub docs to a top-level docs tab, mirrors openclaw/clawhub docs into the publish tree, updates redirects and links, and wires docs CI/publish sync to use the ClawHub docs source.

Reproducibility: not applicable. as a bug reproduction; this is a docs and publish-workflow PR. The changed behavior has local dry-run proof, and live CI currently shows the docs check failing while the paired ClawHub dependency is still open.

Real behavior proof
Sufficient (live_output): The PR body provides after-fix local dry-run output and observed publish-tree results for the docs mirroring behavior, and the dedicated proof check passed.

Next step before merge
The protected maintainer label, open paired ClawHub dependency, and failing docs check make this a human sequencing and merge-readiness decision rather than an autonomous repair job.

Security
Cleared: The workflow changes add an intended checkout of the public openclaw/clawhub repo with credentials not persisted, and I found no concrete security or supply-chain regression.

Review details

Best possible solution:

Land the ClawHub docs-source split first, then merge this PR only after docs CI and publish dry-run proof pass against ClawHub main.

Do we have a high-confidence way to reproduce the issue?

Not applicable as a bug reproduction; this is a docs and publish-workflow PR. The changed behavior has local dry-run proof, and live CI currently shows the docs check failing while the paired ClawHub dependency is still open.

Is this the best way to solve the issue?

Unclear as merge-ready today: the docs-mirroring direction is coherent, but the safest path is to land the paired ClawHub PR first and rerun this PR's docs checks before merge.

What I checked:

  • Protected live PR state: GitHub API shows this PR is open and unmerged, labeled maintainer, docs, scripts, and size: L, with head af50dc9ace6cdd6de0dc0f700dbbbfd87fbe603b. (af50dc9ace6c)
  • New ClawHub docs tab and redirects: The PR redirects old ClawHub routes to /clawhub and adds a top-level ClawHub navigation tab with pages under clawhub/*. Public docs: docs/docs.json. (docs/docs.json:1328, af50dc9ace6c)
  • ClawHub mirroring implementation: syncClawHubDocsTree copies ClawHub docs/** into docs/clawhub, excludes specs, rewrites ClawHub markdown links, and records OpenClaw plus ClawHub source metadata. (scripts/docs-sync-publish.mjs:565, af50dc9ace6c)
  • Docs check uses ClawHub source checkout: The CI docs job now checks out openclaw/clawhub into clawhub-source and passes that path to pnpm check:docs. (.github/workflows/ci.yml:1745, af50dc9ace6c)
  • Paired ClawHub dependency remains open: The declared dependency docs: split ClawHub public docs from specs clawhub#2095 is open and unmerged; it adds docs/clawhub.md and moves internal spec docs out of the mirrored docs tree. (43168bea8656)
  • Current CI status: GitHub Actions reports the current head's check-docs job failed at the Check docs step, while the ClawHub checkout step itself completed successfully. (af50dc9ace6c)

Likely related people:

  • steipete: Recent history on .github/workflows/docs-sync-publish.yml, .github/workflows/ci.yml, and docs sync validation shows repeated ownership of the publish/CI path touched here. (role: recent maintainer of docs publish workflow and CI surface; confidence: high; commits: 7a63dd3f12b5, 6fea42fc2d37, 3fa089de19e8; files: .github/workflows/docs-sync-publish.yml, .github/workflows/ci.yml, scripts/docs-sync-publish.mjs)
  • vincentkoc: Recent commits updated ClawHub/plugin docs and docs sync locale behavior, including the existing docs/tools/clawhub.md surface this PR redirects. (role: recent maintainer of ClawHub/plugin docs and docs sync behavior; confidence: high; commits: 736f627fb558, cf21bcf9bfff, 38990c0e0979; files: docs/tools/clawhub.md, docs/plugins/community.md, scripts/docs-sync-publish.mjs)
  • velvet-shark: Earlier docs link-audit work appears in the history of scripts/docs-link-audit.mjs, which this PR extends to mirror ClawHub docs during link checks. (role: adjacent docs link-audit owner; confidence: medium; commits: 4680335b2a4f, 47ae562cc925; files: scripts/docs-link-audit.mjs)
  • Patrick-Erichsen: Beyond authoring this PR, prior merged history shows relevant ClawHub docs work in docs/tools/clawhub.md, so they have useful context for this docs surface. (role: recent ClawHub docs contributor; confidence: medium; commits: a235a487d029; files: docs/tools/clawhub.md)

Remaining risk / open question:

  • The paired ClawHub source-docs PR is still open, so the canonical docs/clawhub.md source is not yet on openclaw/clawhub:main.
  • The current PR head has a failing check-docs CI job that should be rerun after the dependency lands.
  • The PR has local dry-run proof, but not live Mintlify production deployment proof.

Codex review notes: model gpt-5.5, reasoning high; reviewed against 83aad863fd77.

@clawsweeper clawsweeper Bot added the proof: sufficient ClawSweeper judged the real behavior proof convincing. label May 8, 2026
@Patrick-Erichsen Patrick-Erichsen merged commit 10f9a75 into main May 8, 2026
87 of 88 checks passed
@Patrick-Erichsen Patrick-Erichsen deleted the pe/clawhub-docs-tab branch May 8, 2026 01:55
github-actions Bot pushed a commit to Desicool/openclaw that referenced this pull request May 9, 2026
* docs: add clawhub docs tab

* fix: satisfy docs sync lint

* docs: prune internal clawhub nav pages

* docs: include ClawHub publishing page in nav

* docs: use clawhub how-it-works route
rogerdigital pushed a commit to rogerdigital/openclaw that referenced this pull request May 9, 2026
* docs: add clawhub docs tab

* fix: satisfy docs sync lint

* docs: prune internal clawhub nav pages

* docs: include ClawHub publishing page in nav

* docs: use clawhub how-it-works route
lykeion-dev pushed a commit to lykeion-dev/openclaw--rev that referenced this pull request May 14, 2026
* docs: add clawhub docs tab

* fix: satisfy docs sync lint

* docs: prune internal clawhub nav pages

* docs: include ClawHub publishing page in nav

* docs: use clawhub how-it-works route
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation maintainer Maintainer-authored PR proof: sufficient ClawSweeper judged the real behavior proof convincing. scripts Repository scripts size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant