docs: clarify sub-agent sandbox prerequisites - #5402
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe sub-agent setup documentation gains a prerequisite paragraph before the ChangesSub-agent setup documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/inference/set-up-sub-agent.mdx (1)
54-58: 💤 Low valueWrap this prerequisite in a Fern callout.
This is a prerequisite note in an MDX page, so it should use
<Note>or<Warning>instead of plain prose. Also, rewrite “is onboarded” in active voice and keep the sentence on one line. As per coding guidelines, use Fern callout components for callouts in MDX pages, use active voice, and keep one sentence per line in source files.Proposed shape
- Before you run the `docker exec` commands in this section, finish the - [Quickstart](../get-started/quickstart) and make sure the target sandbox is - onboarded and running on this host. The commands discover the sandbox container - from the `openshell.ai/sandbox-name` Docker label, so the sandbox container must - exist before `SANDBOX_CTR` can resolve. +<Note> +Before you run the `docker exec` commands in this section, finish the [Quickstart](../get-started/quickstart) and start a sandbox on this host. The commands discover the sandbox container from the `openshell.ai/sandbox-name` Docker label, so the sandbox container must exist before `SANDBOX_CTR` can resolve. +</Note>🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/inference/set-up-sub-agent.mdx` around lines 54 - 58, Wrap the prerequisite text that begins with "Before you run the `docker exec` commands" in a Fern callout component (either `<Note>` or `<Warning>`). Within the callout, rewrite the phrase "is onboarded and running" to use active voice instead (change to "onboard and run" or similar active construction). Additionally, ensure each sentence in the callout is kept on one line in the source file to follow the coding guidelines for MDX pages.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/inference/set-up-sub-agent.mdx`:
- Around line 54-58: Wrap the prerequisite text that begins with "Before you run
the `docker exec` commands" in a Fern callout component (either `<Note>` or
`<Warning>`). Within the callout, rewrite the phrase "is onboarded and running"
to use active voice instead (change to "onboard and run" or similar active
construction). Additionally, ensure each sentence in the callout is kept on one
line in the source file to follow the coding guidelines for MDX pages.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: c1227c86-7e5c-4b8d-b328-0fedc70201d9
📒 Files selected for processing (1)
docs/inference/set-up-sub-agent.mdx
Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
575301c to
2dc00f4
Compare
…rereq-5077 # Conflicts: # docs/inference/set-up-sub-agent.mdx
|
Merged current After the update, the PR now shows 0 changed files because the same sub-agent setup guidance appears to have landed upstream via #5521. So there is no remaining code/docs delta from this branch; leaving this note here so the current PR state is easier to interpret. |
wscurran
added
area: docs
|
✨ Thanks for adding the Quickstart/running-sandbox prerequisite before the Docker-driver config commands. This proposes a way to clarify sub-agent sandbox setup by failing fast with a clear message when the sandbox container cannot be found. Related open issues: |
|
Closing this stale PR because it now has 0 changed files after the same sub-agent prerequisite guidance landed upstream via #5521, as noted above. This keeps the open PR queue focused on branches with an active reviewable delta. |
2 participants
Summary
Clarifies that the sub-agent sandbox config commands require an onboarded, running sandbox on the host before the container lookup can succeed. The example now fails fast with a clear message when the sandbox container cannot be found.
Related Issue
Fixes #5077
Changes
openshell.ai/sandbox-nameDocker label.docker execwhenSANDBOX_CTRis empty.Type of Change
Verification
npx prek run --from-ref main --to-ref HEADpassesnpm testpasses (broad runtime changes only)npm run docsbuilds without warnings (doc changes only)Verification run:
npx prek run --from-ref origin/main --to-ref HEADnpm run docs(passed with 0 errors; Fern reported existing warnings/upgrade notice)Signed-off-by: WilliamK112 164879897+WilliamK112@users.noreply.github.com
Summary by CodeRabbit