docs: fast-follow to improve Brev web UI guide and update doc-only PR contribution instruction#3050
docs: fast-follow to improve Brev web UI guide and update doc-only PR contribution instruction#3050
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe PR moves a Brev Web UI quickstart into a new deployment guide, updates the docs index to the new path, deletes the old quickstart file, adds doc-only PR verification guidance across contributor docs and a skill, updates the PR template placeholder, and configures Sphinx to suppress info logs from the redirect plugin. ChangesDocumentation Reorganization & Verification Guidance
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 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 |
Co-authored-by: Cursor <cursoragent@cursor.com>
miyoungc
changed the title
miyoungc
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/deployment/brev-web-ui.md (1)
29-30: 💤 Low valueRephrase to avoid repetition.
The phrase "want to" appears in consecutive sentences.
Consider replacing the second instance to add variety.Example revision:
Use this guide when you want to try NemoClaw without installing the CLI or using a local GPU. -If you want to manage the remote host from a terminal, see [Deploy to a Remote GPU Instance](deploy-to-remote-gpu.md). +To manage the remote host from a terminal, see [Deploy to a Remote GPU Instance](deploy-to-remote-gpu.md).🤖 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/deployment/brev-web-ui.md` around lines 29 - 30, The two sentences repeat the phrase "want to"; update the second sentence that begins "If you want to manage the remote host from a terminal..." to avoid repetition — e.g., reword it to "To manage the remote host from a terminal, see [Deploy to a Remote GPU Instance](deploy-to-remote-gpu.md)." — keep the first sentence ("Use this guide when you want to try NemoClaw without installing the CLI or using a local GPU.") unchanged and ensure the replacement removes the duplicate "want to".
🤖 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.
Inline comments:
In `@docs/deployment/brev-web-ui.md`:
- Around line 116-121: Replace the four-colon MyST admonition delimiter
`::::{note}`/`::::` with the correct three-colon form `:::{note}`/`:::` and
split the line that currently contains two sentences ("Wait for about a few
minutes for pairing to finish automatically. Refresh the dashboard to see if the
warning is resolved and the connection is established.") into two separate lines
so each sentence is on its own line; also change "about a few minutes" to "a few
minutes" for clarity.
---
Nitpick comments:
In `@docs/deployment/brev-web-ui.md`:
- Around line 29-30: The two sentences repeat the phrase "want to"; update the
second sentence that begins "If you want to manage the remote host from a
terminal..." to avoid repetition — e.g., reword it to "To manage the remote host
from a terminal, see [Deploy to a Remote GPU
Instance](deploy-to-remote-gpu.md)." — keep the first sentence ("Use this guide
when you want to try NemoClaw without installing the CLI or using a local GPU.")
unchanged and ensure the replacement removes the duplicate "want to".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: df944f5a-7169-4764-bb33-e408adb41bfe
📒 Files selected for processing (4)
docs/conf.pydocs/deployment/brev-web-ui.mddocs/get-started/brev-web-ui-quickstart.mddocs/index.md
💤 Files with no reviewable changes (1)
- docs/get-started/brev-web-ui-quickstart.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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.
Inline comments:
In `@docs/CONTRIBUTING.md`:
- Around line 114-117: Update the CLI example block in CONTRIBUTING.md to use
the console code fence and add shell prompt prefixes: replace the existing
```bash block with ```console and prefix each command line with "$ " (e.g., "$
npx prek run --all-files" and "$ make docs") so the example follows the required
`console` language tag and prompt convention.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: faa3f8c9-0acc-4cb9-a0e7-12d4826e8908
📒 Files selected for processing (4)
.agents/skills/nemoclaw-contributor-create-pr/SKILL.md.github/PULL_REQUEST_TEMPLATE.mdCONTRIBUTING.mddocs/CONTRIBUTING.md
✅ Files skipped from review due to trivial changes (2)
- .github/PULL_REQUEST_TEMPLATE.md
- CONTRIBUTING.md
Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/deployment/brev-web-ui.md (1)
43-45: ⚡ Quick winAdd a one-sentence intro before section lists.
Both
## Prerequisitesand## Launch NemoClaw from Brevstart directly with list items. Add one introductory sentence under each heading before the list.As per coding guidelines, "Sections use H2 and H3, each starting with an introductory sentence."
Also applies to: 63-66
🤖 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/deployment/brev-web-ui.md` around lines 43 - 45, The headings "## Prerequisites" and "## Launch NemoClaw from Brev" (and the section around lines 63-66) begin immediately with lists; add a single introductory sentence under each H2 that briefly describes the purpose of the section before the list items so the section follows the guideline "Sections use H2 and H3, each starting with an introductory sentence." Locate the headings "## Prerequisites" and "## Launch NemoClaw from Brev" and insert one clear, concise sentence under each (e.g., what the reader will need or what the section will show) before the existing bullet lists.
🤖 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/deployment/brev-web-ui.md`:
- Around line 43-45: The headings "## Prerequisites" and "## Launch NemoClaw
from Brev" (and the section around lines 63-66) begin immediately with lists;
add a single introductory sentence under each H2 that briefly describes the
purpose of the section before the list items so the section follows the
guideline "Sections use H2 and H3, each starting with an introductory sentence."
Locate the headings "## Prerequisites" and "## Launch NemoClaw from Brev" and
insert one clear, concise sentence under each (e.g., what the reader will need
or what the section will show) before the existing bullet lists.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 50b5f64b-6f02-4902-8256-d40657af0a18
📒 Files selected for processing (1)
docs/deployment/brev-web-ui.md
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/deployment/brev-web-ui.md (1)
52-52: ⚡ Quick winSplit Line 52 into one sentence per line.
Line 52 currently contains two sentences on a single source line; split them into separate lines to match docs formatting rules.
As per coding guidelines, “One sentence per line in source (makes diffs readable).”
🤖 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/deployment/brev-web-ui.md` at line 52, Split the source line that currently reads "If you already have an NVIDIA API key skip this section. Otherwise, follow these steps to generate a new key:" into two separate lines so each sentence is on its own source line; locate the exact string "If you already have an NVIDIA API key skip this section. Otherwise, follow these steps to generate a new key:" and replace it with two lines: one containing "If you already have an NVIDIA API key skip this section." and the next containing "Otherwise, follow these steps to generate a new key:" ensuring trailing punctuation and whitespace are preserved.
🤖 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/deployment/brev-web-ui.md`:
- Line 52: Split the source line that currently reads "If you already have an
NVIDIA API key skip this section. Otherwise, follow these steps to generate a
new key:" into two separate lines so each sentence is on its own source line;
locate the exact string "If you already have an NVIDIA API key skip this
section. Otherwise, follow these steps to generate a new key:" and replace it
with two lines: one containing "If you already have an NVIDIA API key skip this
section." and the next containing "Otherwise, follow these steps to generate a
new key:" ensuring trailing punctuation and whitespace are preserved.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 73b89393-88ea-4d97-9b7d-f6ea1f9acab1
📒 Files selected for processing (1)
docs/deployment/brev-web-ui.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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.
Inline comments:
In `@docs/deployment/brev-web-ui.md`:
- Around line 18-21: The SPDX header is currently inside a single multi-line
HTML comment; replace it with two separate single-line HTML comments so each
SPDX tag is on its own line: one comment containing "SPDX-FileCopyrightText:
..." and a second comment containing "SPDX-License-Identifier: ..."; update the
block containing SPDX-FileCopyrightText and SPDX-License-Identifier so they
appear as <!-- SPDX-FileCopyrightText: ... --> and <!-- SPDX-License-Identifier:
... --> respectively at the top of the document.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 7bcdff9a-edb7-4a0e-8287-c2ca8ccaf793
📒 Files selected for processing (1)
docs/deployment/brev-web-ui.md
ericksoa
left a comment
ericksoa
left a comment
There was a problem hiding this comment.
Could we preserve the old published URL for this moved page before merging?
The PR moves docs/get-started/brev-web-ui-quickstart.md to docs/deployment/brev-web-ui.md, but I do not see a corresponding entry in the redirects map in docs/conf.py. Should this move add a redirect such as:
"get-started/brev-web-ui-quickstart": "../deployment/brev-web-ui.html",so existing links to /get-started/brev-web-ui-quickstart.html keep working after the page moves?
I checked the built output locally after make docs-strict: the new page is emitted at deployment/brev-web-ui.html, but get-started/brev-web-ui-quickstart.html is not generated.
|
@ericksoa This is a fast follow after the initial page just merged (NVIDIA/NemoClaw#2563)) a little before this PR. The new page hasn't been published, so no need for a redirect. |
ericksoa
left a comment
ericksoa
left a comment
There was a problem hiding this comment.
Approved after re-review. The earlier redirect concern is resolved by the fast-follow timing: the moved page has not been published yet, and the new deployment path is linked from the docs index. I also verified the doc build locally and reviewed the current PR checks.
3 participants
Summary
Improves the Brev Web UI guide so it matches the current UI flow for deploying the instance, opening the setup page, configuring providers, and handling gateway pairing. Also clarifies that doc-only PRs should use docs and hook verification instead of requiring the full test suite by default.
Related Issue
None.
Changes
docs/deployment/and updates the docs toctree entry.sphinx-reredirectsinfo logs during incremental docs builds while keeping redirect warnings visible.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit