Skip to content

fix: document canonical min noun-verb command spellings - #1141

Merged
twitchyliquid64 merged 2 commits into
mainfrom
inbox-patch/document-canonical-min-spellings-47eb0104cbe7bb47
Aug 5, 2026
Merged

fix: document canonical min noun-verb command spellings#1141
twitchyliquid64 merged 2 commits into
mainfrom
inbox-patch/document-canonical-min-spellings-47eb0104cbe7bb47

Conversation

@gominimal-aw-bot

@gominimal-aw-bot gominimal-aw-bot Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Routing-Key: inbox-route/I_kwDOSUhdos8AAAABK66mtw

The in-sandbox min helper accepts canonical noun-verb spellings — min task run, min package add, and min package search — alongside the older bare min run / min add / min search, but docs/reference/sandbox-operations.md documented only the bare forms, so readers could not tell the canonical spelling from its alias. This notes the canonical spelling and its accepted alias under the add, search, and run commands. The accepted set was verified against the helper sources (crates/mctx/src/min_helper.sh, crates/minimald/src/env_min_helper.sh) and the SSH exec channel (crates/minimald/src/exec.rs), whose doc comment labels min task run canonical and min run a legacy alias. Guide pages that use the bare aliases are left unchanged (the aliases stay valid); the session-CLI reference cli-min.md documents a separate tool and is unaffected.

Verification

  • cargo fmt --all --check --manifest-path target/Cargo.toml — passed
  • cargo clippy --workspace --locked -- -D warnings — passed, no warnings
  • cargo build --workspace --locked — passed
  • cargo test --workspace --locked — passed (78 test result groups, 0 failed)

Generated by inbox-patch ·

Note

Document canonical noun-verb command spellings in min CLI docs

Updates tasks.md and sandbox-operations.md to clarify that min task run, min package add, and min package search are the canonical command forms, while min run, min add, and min search are legacy aliases.

Macroscope summarized 3989fed.

minimal#1133 taught the in-sandbox min helper the canonical noun-verb
spellings (min task run, min package add, min package search), but
shipped no docs, so the sandbox-operations reference still taught only
the bare forms. Note each canonical spelling and its accepted alias
under the add, search, and run commands.
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 26 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 355ae495-0c65-44cb-b383-d6d8eda7a75e

📥 Commits

Reviewing files that changed from the base of the PR and between 7e690dc and 3989fed.

📒 Files selected for processing (2)
  • docs/guide/tasks.md
  • docs/reference/sandbox-operations.md

Comment @coderabbitai help to get the list of available commands.

The reference page now states the canonical noun-verb spellings, but the
tasks guide still introduced the command as bare `min run`, which is the
first place a reader meets it.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018QCWCa2XxqtLnQPPP7xMwU
@norrietaylor

Copy link
Copy Markdown
Member

Pushed one commit to this branch: the guide at docs/guide/tasks.md:9 still introduced the command as bare min run <name>, which is the first place a reader meets it. The routing decision for gominimal/inbox#456 named that file alongside sandbox-operations.md, so the original diff covered one of the two documented gaps.

Verified the claims this PR makes are accurate before extending them — crates/minimald/src/exec.rs:862 and :892 handle the task and package nouns, and exec_accepts_task_run_canonical_form covers the canonical form.

@norrietaylor
norrietaylor marked this pull request as ready for review July 31, 2026 22:10
@norrietaylor
norrietaylor requested a review from a team as a code owner July 31, 2026 22:10
@twitchyliquid64
twitchyliquid64 merged commit 999d64c into main Aug 5, 2026
30 checks passed
@twitchyliquid64
twitchyliquid64 deleted the inbox-patch/document-canonical-min-spellings-47eb0104cbe7bb47 branch August 5, 2026 01:43
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