Skip to content

docs: point README onboarding link to CLI wizard#84995

Closed
Zacxxx wants to merge 1 commit into
openclaw:mainfrom
Zacxxx:docs/readme-cli-onboarding-link
Closed

docs: point README onboarding link to CLI wizard#84995
Zacxxx wants to merge 1 commit into
openclaw:mainfrom
Zacxxx:docs/readme-cli-onboarding-link

Conversation

@Zacxxx

@Zacxxx Zacxxx commented May 21, 2026

Copy link
Copy Markdown

Summary

  • Problem: the README model note links "Onboarding" to /start/onboarding, which is the macOS app onboarding page, while this README section is describing the CLI setup path.
  • Solution: point that link to /start/wizard, matching the other CLI onboarding links already used in the README.
  • What changed: one README URL.
  • What did NOT change (scope boundary): no runtime behavior, generated docs, config, install commands, or app code changed.

Motivation

Keep first-run README navigation consistent for users following the CLI onboarding path.

Change Type (select all)

  • Bug fix
  • Feature
  • Refactor required for the fix
  • Docs
  • Security hardening
  • Chore/infra

Scope (select all touched areas)

  • Gateway / orchestration
  • Skills / tool execution
  • Auth / tokens
  • Memory / storage
  • Integrations
  • API / contracts
  • UI / DX
  • CI/CD / infra

Linked Issue/PR

  • Closes N/A
  • Related N/A
  • This PR fixes a bug or regression

Real behavior proof (required for external PRs)

  • Behavior or issue addressed: README onboarding links for the CLI path now point to the CLI onboarding wizard.
  • Real environment tested: Ubuntu 24.04.4 LTS, local checkout.
  • Exact steps or command run after this patch:
git diff --check
test -f docs/start/wizard.md
rg -n 'docs.openclaw.ai/start/wizard|docs.openclaw.ai/start/onboarding' README.md | sed -n '1,20p'
  • Evidence after fix:
28:[Website](https://openclaw.ai) ... [Onboarding](https://docs.openclaw.ai/start/wizard) ...
95:Model note: ... See [Onboarding](https://docs.openclaw.ai/start/wizard).
155:- **[Onboarding](https://docs.openclaw.ai/start/wizard) + [skills](https://docs.openclaw.ai/tools/skills)** ...
173:- New here: ... [Onboarding](https://docs.openclaw.ai/start/wizard), ...
  • Observed result after fix: the README no longer links this CLI onboarding reference to /start/onboarding.
  • What was not tested: live Mintlify production deployment.
  • Before evidence (optional but encouraged): line 95 pointed to https://docs.openclaw.ai/start/onboarding.

Root Cause (if applicable)

N/A

Regression Test Plan (if applicable)

N/A

User-visible / Behavior Changes

README readers are sent to the CLI onboarding wizard from the model note.

Diagram (if applicable)

N/A

Security Impact (required)

  • New permissions/capabilities? No
  • Secrets/tokens handling changed? No
  • New/changed network calls? No
  • Command/tool execution surface changed? No
  • Data access scope changed? No
  • If any Yes, explain risk + mitigation: N/A

Repro + Verification

Environment

  • OS: Ubuntu 24.04.4 LTS
  • Runtime/container: N/A
  • Model/provider: N/A
  • Integration/channel (if any): N/A
  • Relevant config (redacted): N/A

Steps

  1. Inspect README.md onboarding links.
  2. Verify docs/start/wizard.md exists in the docs source.
  3. Run git diff --check.

Expected

The README CLI onboarding reference points to /start/wizard.

Actual

The README CLI onboarding reference points to /start/wizard.

Evidence

  • Trace/log snippets

Human Verification (required)

What you personally verified (not just CI), and how:

  • Verified scenarios: checked README link target and confirmed the docs source page exists.
  • Edge cases checked: no remaining /start/onboarding link in README output from the targeted rg command.
  • What you did not verify: live docs deployment after merge.

AI assistance: this PR was prepared with Codex. I reviewed the one-line docs change and ran the verification above locally.

Review Conversations

  • I replied to or resolved every bot review conversation I addressed in this PR.
  • I left unresolved only the conversations that still need reviewer or maintainer judgment.

Compatibility / Migration

  • Backward compatible? Yes
  • Config/env changes? No
  • Migration needed? No
  • If yes, exact upgrade steps: N/A

Risks and Mitigations

None

@openclaw-barnacle openclaw-barnacle Bot added size: XS proof: supplied External PR includes structured after-fix real behavior proof. triage: docs-discoverability Candidate: docs discoverability/listing change may belong elsewhere. triage: low-signal-docs Candidate: docs-only change looks low signal; maintainer review needed. labels May 21, 2026
@clawsweeper

clawsweeper Bot commented May 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Codex review: needs maintainer review before merge.

Workflow note: Future ClawSweeper reviews update this same comment in place.

How this review workflow works
  • ClawSweeper keeps one durable marker-backed review comment per issue or PR.
  • Re-runs edit this comment so the latest verdict, findings, and automation markers stay together instead of adding duplicate bot comments.
  • A fresh review can be triggered by eligible @clawsweeper re-review comments, exact-item GitHub events, scheduled/background review runs, or manual workflow dispatch.
  • PR/issue authors and users with repository write access can comment @clawsweeper re-review or @clawsweeper re-run on an open PR or issue to request a fresh review only.
  • Maintainers can also comment @clawsweeper review to request a fresh review only.
  • Fresh-review commands do not start repair, autofix, rebase, CI repair, or automerge.
  • Maintainer-only repair and merge flows require explicit commands such as @clawsweeper autofix, @clawsweeper automerge, @clawsweeper fix ci, or @clawsweeper address review.
  • Maintainers can comment @clawsweeper explain to ask for more context, or @clawsweeper stop to stop active automation.

Summary
The PR changes one README onboarding URL from the macOS app onboarding page to the CLI onboarding wizard.

Reproducibility: yes. The mismatch is source-reproducible by reading README.md line 95 on current main and comparing it with the existing CLI and macOS onboarding docs.

PR rating
Overall: 🦞 diamond lobster
Proof: 🦞 diamond lobster
Patch quality: 🦞 diamond lobster
Summary: Small, correct docs patch with direct source proof and no blocking review findings.

What the crustacean ranks mean
  • 🦀 challenger crab: rare, exceptional readiness with strong proof, clean implementation, and convincing validation.
  • 🦞 diamond lobster: very strong readiness with only minor maintainer review expected.
  • 🐚 platinum hermit: good normal PR, likely mergeable with ordinary maintainer review.
  • 🦐 gold shrimp: useful signal, but proof or patch confidence is still limited.
  • 🦪 silver shellfish: thin signal; proof, validation, or implementation needs work.
  • 🧂 unranked krab: not merge-ready because proof is missing/unusable or there are serious correctness or safety concerns.
  • 🌊 off-meta tidepool: rating does not apply to this item.

Shiny media proof means a screenshot, video, or linked artifact directly shows the changed behavior. Runtime, network, CSP, and security claims still need visible diagnostics.

Real behavior proof
Sufficient (live_output): The PR body includes after-fix copied terminal output showing the README onboarding URLs and confirming docs/start/wizard.md exists, which is sufficient for this README link change.

Next step before merge
No automated repair is needed; this clean docs PR is ready for normal review and merge handling.

Security
Cleared: The diff is a README URL-only change and does not touch secrets, code execution, package resolution, CI, or runtime permissions.

Review details

Best possible solution:

Land the README link update as-is after normal maintainer and CI gates; no runtime, docs-nav, or migration work is needed.

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

Yes. The mismatch is source-reproducible by reading README.md line 95 on current main and comparing it with the existing CLI and macOS onboarding docs.

Is this the best way to solve the issue?

Yes. Updating the single README URL is the narrowest maintainable fix because /start/wizard already exists as the CLI onboarding page and /start/onboarding is explicitly the macOS app page.

Label changes:

  • add P3: This is a low-risk README discoverability fix with no runtime or configuration impact.
  • add proof: sufficient: Contributor real behavior proof is sufficient. The PR body includes after-fix copied terminal output showing the README onboarding URLs and confirming docs/start/wizard.md exists, which is sufficient for this README link change.
  • add rating: 🦞 diamond lobster: Current PR rating is 🦞 diamond lobster because proof is 🦞 diamond lobster, patch quality is 🦞 diamond lobster, and Small, correct docs patch with direct source proof and no blocking review findings.
  • add status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Sufficient (live_output): The PR body includes after-fix copied terminal output showing the README onboarding URLs and confirming docs/start/wizard.md exists, which is sufficient for this README link change.

Label justifications:

  • P3: This is a low-risk README discoverability fix with no runtime or configuration impact.
  • rating: 🦞 diamond lobster: Current PR rating is 🦞 diamond lobster because proof is 🦞 diamond lobster, patch quality is 🦞 diamond lobster, and Small, correct docs patch with direct source proof and no blocking review findings.
  • status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Sufficient (live_output): The PR body includes after-fix copied terminal output showing the README onboarding URLs and confirming docs/start/wizard.md exists, which is sufficient for this README link change.
  • proof: sufficient: Contributor real behavior proof is sufficient. The PR body includes after-fix copied terminal output showing the README onboarding URLs and confirming docs/start/wizard.md exists, which is sufficient for this README link change.

What I checked:

Likely related people:

  • steipete: git blame shows the current model note and nearby README onboarding links came from commit a329b9e by Peter Steinberger. (role: introduced current README onboarding copy; confidence: high; commits: a329b9e1ee10; files: README.md)

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

@clawsweeper clawsweeper Bot added proof: sufficient ClawSweeper judged the real behavior proof convincing. rating: 🦞 diamond lobster Very strong PR readiness with only minor maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. P3 Low-priority cleanup, docs, polish, ergonomics, or speculative work. labels May 21, 2026
@clawsweeper

clawsweeper Bot commented May 21, 2026

Copy link
Copy Markdown
Contributor

ClawSweeper PR egg

✨ Hatched: 🌱 uncommon Frosted Crabkin

Hatch command

Comment @clawsweeper hatch when this PR is hatchable.

Hatchability rules:

  • Merged PRs are hatchable.
  • Open PRs are hatchable when they are status: 👀 ready for maintainer look, status: 🚀 automerge armed, or labeled clawsweeper:automerge.
  • Closed unmerged PRs are hatchable only when one of those hatchable labels is still present in the durable record.

Rarity: 🌱 uncommon.
Trait: stacks clean commits.
Image traits: location green-check meadow; accessory miniature diff map; palette plum, gold, and soft gray; mood bright-eyed; pose nestled inside a glowing shell; shell soft velvet shell; lighting tiny status-light glow; background tiny shells and proof notes.
Share on X: post this hatch
Copy: My PR egg hatched a 🌱 uncommon Frosted Crabkin in ClawSweeper.

What is this egg doing here?
  • Eggs appear after the PR passes real-behavior proof. It is here for vibes, not verdicts: it does not change labels, ratings, merge decisions, or automation.
  • The shell reacts to review momentum: open follow-up work warms it up, re-review makes it wobble, and a clean final review lets it hatch.
  • Hatchability usually comes from sufficient real-behavior proof, no blocking P0/P1/P2 findings, no security attention needed, and clean correctness. A merged PR is already final, so merge makes the egg hatchable independently.
  • The hatch is seeded from this repository and PR number, so the same PR keeps the same creature; the reviewed head SHA can only change safe visual details.
  • Rarity is just collectible sparkle: 🥚 common, 🌱 uncommon, 💎 rare, ✨ glimmer, and 🌈 legendary.

@steipete

steipete commented May 22, 2026

Copy link
Copy Markdown
Contributor

Thanks for the docs contribution. I absorbed the useful part into main in 658be7f and kept the wording aligned with the current docs/source shape instead of landing this branch directly.

Proof: git diff --check; pnpm docs:list; node scripts/run-vitest.mjs src/gateway/server-plugins.test.ts (45 tests).

@steipete steipete closed this May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

P3 Low-priority cleanup, docs, polish, ergonomics, or speculative work. proof: sufficient ClawSweeper judged the real behavior proof convincing. proof: supplied External PR includes structured after-fix real behavior proof. rating: 🦞 diamond lobster Very strong PR readiness with only minor maintainer review expected. size: XS status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. triage: docs-discoverability Candidate: docs discoverability/listing change may belong elsewhere. triage: low-signal-docs Candidate: docs-only change looks low signal; maintainer review needed.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Zacxxx @steipete