Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds documentation and quickstart cross-reference for running agents in detached/background mode, including examples for starting with Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/agents/index.md`:
- Line 169: Replace the British spelling "customisations" in the sentence "Apply
your customisations — install packages, edit config files, set environment
variables, etc." with the American spelling "customizations" and run a quick
grep/search for any other occurrences of "customisations" in the docs to
standardize them to "customizations" to match the existing use (e.g., the
earlier "customization") across the repository.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 853cb3b7-d23f-4cd2-b3bc-8e69275ab6cd
📒 Files selected for processing (2)
docs/agents/index.mddocs/quickstart.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/agents/index.md (1)
135-135:⚠️ Potential issue | 🟡 MinorInconsistent spelling: use "customize" to match American English convention.
The document uses "customizations" (American spelling) on line 169 but "customise" (British spelling) here. For consistency, standardize on American English throughout.
📝 Proposed fix
-Use `-d` / `--detach` to start an agent container in the background without attaching your terminal. This is useful when you want to customise the container environment before launching the agent interactively. +Use `-d` / `--detach` to start an agent container in the background without attaching your terminal. This is useful when you want to customize the container environment before launching the agent interactively.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/agents/index.md` at line 135, Replace the British spelling "customise" in the sentence "This is useful when you want to customise the container environment before launching the agent interactively." with American "customize"; search the document for other British variants like "customise", "customised", "customising", or "customisations" and standardize them to American spellings ("customize", "customized", "customizing", "customizations") so the file uses consistent American English.
🧹 Nitpick comments (1)
docs/agents/index.md (1)
196-196: Consider showing the exact YAML structure forauto_removeconfiguration.For consistency with other configuration examples in this document (lines 71-75, 85-88, 113-117), consider showing the exact YAML structure for setting
auto_remove: falseinstead of just mentioning it.📋 Optional improvement
-- **`auto_remove` (default: `true`)** — By default, containers are automatically removed when they stop. This means you cannot restart a stopped detached container; you need to `vp run` again. Set `auto_remove: false` in your [configuration](../configuration.md) if you want stopped containers to persist. +- **`auto_remove` (default: `true`)** — By default, containers are automatically removed when they stop. This means you cannot restart a stopped detached container; you need to `vp run` again. Set `auto_remove: false` in your [configuration](../configuration.md) if you want stopped containers to persist: + + ```yaml + agents: + claude: + auto_remove: false + ```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/agents/index.md` at line 196, Add an explicit YAML example showing how to set auto_remove to false in the configuration instead of just mentioning it; update the paragraph that currently references **`auto_remove` (default: `true`)** to include a small code block with the exact keys (e.g., agents: → <agent_name>: → auto_remove: false) so readers can copy/paste the config consistent with the other examples; reference the same structure used elsewhere in the doc and ensure the snippet points to the configuration discussed in configuration.md.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/agents/index.md`:
- Line 150: Change the British spelling in the header "### Customising the
container before starting the agent" to American English by updating it to "###
Customizing the container before starting the agent" and scan the surrounding
content (notably the occurrence of "customizations") to ensure all related
headings and body text consistently use "customizing"/"customizations" in
American spelling.
- Line 171: Update step 4 to include the exact commands to start each agent
inside the container: after exec-ing in, show concrete examples like running the
agent binary by name (e.g., use "claude" for Claude, "gemini" for Gemini,
"opencode" for Opencode, "auggie" for Auggie, "copilot" for Copilot, "codex" for
Codex) and mention that the user should invoke the relevant agent command (agent
name) to start the process; ensure the text in the guide replaces the vague
"start the agent process" with these specific commands and a short note that the
command is run inside the container shell.
---
Duplicate comments:
In `@docs/agents/index.md`:
- Line 135: Replace the British spelling "customise" in the sentence "This is
useful when you want to customise the container environment before launching the
agent interactively." with American "customize"; search the document for other
British variants like "customise", "customised", "customising", or
"customisations" and standardize them to American spellings ("customize",
"customized", "customizing", "customizations") so the file uses consistent
American English.
---
Nitpick comments:
In `@docs/agents/index.md`:
- Line 196: Add an explicit YAML example showing how to set auto_remove to false
in the configuration instead of just mentioning it; update the paragraph that
currently references **`auto_remove` (default: `true`)** to include a small code
block with the exact keys (e.g., agents: → <agent_name>: → auto_remove: false)
so readers can copy/paste the config consistent with the other examples;
reference the same structure used elsewhere in the doc and ensure the snippet
points to the configuration discussed in configuration.md.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds documentation for the "detached mode" feature, which allows users to start agent containers in the background without attaching their terminal. The updates clarify usage, workflows, and caveats for detached mode, and enhance both the agents and quickstart documentation to guide users through these workflows.
Detached mode documentation:
docs/agents/index.mdexplaining how to use-d/--detachto start agent containers in detached mode, including basic usage, customisation workflows, management commands, and important caveats.Quickstart improvements:
docs/quickstart.mdto show how to check running agents withvp list --runningand linked to the new detached mode documentation for further details.Implements #25
Summary by CodeRabbit