Skip to content

docs(release): align v0.8.68 mode FAQ and workflow commands#4331

Merged
Hmbown merged 1 commit into
mainfrom
codex/v0868-doc-fixes
Jul 10, 2026
Merged

docs(release): align v0.8.68 mode FAQ and workflow commands#4331
Hmbown merged 1 commit into
mainfrom
codex/v0868-doc-fixes

Conversation

@Hmbown

@Hmbown Hmbown commented Jul 10, 2026

Copy link
Copy Markdown
Owner

Summary

  • align the English and Chinese FAQ with the shipped Plan / Act / Operate mode contract
  • replace nonexistent codewhale workflow status / workflow logs README examples with the real lane status / lane logs commands
  • add the required --fleet argument to the workflow run example

Why

Claude review of merged release PR #4327 caught both inconsistencies. This keeps the v0.8.68 public docs executable and consistent with the CLI on main @ 7e18d5a2fe260a39258b85c5d1de394c1609b03a.

Verification

  • ./scripts/release/check-versions.sh
  • git diff --check
  • npm --prefix web run check:docs
  • npm --prefix web run lint could not run because this worktree has no eslint binary installed

No release tag, GitHub Release, registry publish, or deploy was performed.

Update the FAQ to describe the shipped Plan, Act, and Operate modes in English and Chinese, and replace nonexistent workflow status/logs subcommands with the real Lane inspection commands. This keeps the v0.8.68 public docs executable and consistent with the CLI.
Copilot AI review requested due to automatic review settings July 10, 2026 05:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@claude

claude Bot commented Jul 10, 2026

Copy link
Copy Markdown

Claude finished @Hmbown's task in 1m 38s —— View job


Review: docs(release) v0.8.68 mode FAQ / workflow command alignment

  • Gather context (diff, CLAUDE.md, AGENTS.md)
  • Review README.md changes
  • Review web/app/[locale]/faq/page.tsx changes
  • Check cross-file consistency (English FAQ, workflow commands elsewhere, actual CLI/mode source)
  • Post final review

Verdict: accurate, low-risk, ready to merge. Docs-only, 2 files, no .rs/logic changes — reviewed against the actual CLI/TUI source rather than just prose.

What I verified:

  • codewhale lane status <lane-id> / codewhale lane logs <lane-id> are real subcommands (crates/cli/src/lib.rs:396-405, LaneCommand::Status/Logs), matching the README replacement of the nonexistent workflow status/workflow logs.
  • --fleet is a required, non-Option field on WorkflowCommand::Run (crates/cli/src/lib.rs:474-479, doc comment: "Required for role-resolved Workflow runs"), so adding --fleet <fleet-name> to the README example fixes a command that would otherwise fail clap's required-arg check. --runtime tmux matches the documented default (default_value = "tmux", line 487).
  • FAQ mode rename (Agent→Act, YOLO removed, Operate added) matches shipped UI behavior, not just internal naming: AppMode still keeps Agent/Yolo as legacy enum variants for compat, but footer.rs:322-337 maps Agent | Auto | Yolo → the "act" badge, and mode_picker.rs explicitly excludes the legacy YOLO shorthand from the visible picker roster (comment: "Legacy YOLO shorthand (4) is not offered by the picker"). So "Act" and "Operate" are the real user-facing labels today, and YOLO is correctly demoted from a listed mode to a compatibility alias — consistent with README.md:219's existing "legacy YOLO remains a compatibility alias for Act + Full Access" language elsewhere in the same file (untouched by this PR, and not contradicted by it).
  • Operate's FAQ description ("durable Fleet/Workflow orchestration for larger, staged jobs... same approval posture") matches crates/tui/src/prompts/modes/operate.md.
  • Chinese FAQ translation mirrors the English changes 1:1 (Act/执行, Operate/编排).
  • git diff --check on the PR diff: clean, no whitespace errors.

Provider/model routing (EPIC #2608): N/A — no code touches model/provider selection.

Nits (non-blocking):

  • None worth holding up this PR for. Scope is tight and correct.

No correctness, safety, or reuse issues found. Nothing further to fix.

@Hmbown Hmbown merged commit 07900d6 into main Jul 10, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants