docs(get-started): add Brev web UI quickstart guide#2563
docs(get-started): add Brev web UI quickstart guide#2563miyoungc merged 12 commits intoNVIDIA:mainfrom
Conversation
docs(get-started): add Brev web UI quickstart guide
|
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:
📝 WalkthroughWalkthroughAdds a Brev Web UI quickstart documenting how to obtain an NVIDIA Changes
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (5)
docs/get-started/brev-web-ui-quickstart.md (5)
120-120: Apply inline code formatting to paths/values in prose.Format tokens like
USER.md,brev.nvidia.com, andbuild.nvidia.comas inline code when referenced in instructions.As per coding guidelines, CLI commands, file paths, flags, parameter names, and values must use inline
codeformatting.Also applies to: 171-171, 178-178
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/brev-web-ui-quickstart.md` at line 120, The prose currently references tokens like USER.md, brev.nvidia.com, and build.nvidia.com without inline code formatting; update the doc text so every instance of file names, hostnames, CLI commands, flags, parameter names and literal values (e.g., USER.md, `brev.nvidia.com`, `build.nvidia.com`) are wrapped in inline code formatting; scan the surrounding paragraphs (including the other noted instances around lines 171 and 178) and replace plain occurrences with inline code-formatted equivalents to follow the guideline.
191-196: Add a bottom “Next Steps” section for related links.Consider renaming/restructuring this final section to match the required page structure.
As per coding guidelines, new pages should include a “Next Steps” section at the bottom linking related pages.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/brev-web-ui-quickstart.md` around lines 191 - 196, The final section currently titled "## Related Topics" should be renamed and restructured to the required page footer format by replacing the "## Related Topics" header with "## Next Steps" and keeping the existing links (Quickstart, Deploy to a Remote GPU Instance, Set Up the Telegram Bridge, Monitor Sandbox Activity) under that header; update any surrounding copy to match the project's page structure conventions (header text and link order/format) so the page includes a bottom "Next Steps" section linking the related pages.
34-34: Use present tense instead of future tense.Phrases like “You will see” and “The agent will …” should be rewritten in present tense.
As per coding guidelines, documentation should use present tense and flag future tense descriptions of current behavior.
Also applies to: 64-64, 111-111, 132-132
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/brev-web-ui-quickstart.md` at line 34, Update the documentation language to present tense by replacing future-tense phrases like "You will see" and "The agent will ..." with present-tense equivalents such as "You see" and "The agent ...", e.g., update the sentence at the NemoClaw setup line that currently reads "You will see the NemoClaw setup page showing:" to "You see the NemoClaw setup page showing:"; make the same present-tense edits for the other occurrences flagged (lines containing the phrases at 64, 111, and 132) to ensure all descriptions of current behavior use present tense.
82-84: Reflow prose to one sentence per line.Several sentences are wrapped across multiple source lines; keep each sentence on a single line for diff readability.
As per coding guidelines, source must use one sentence per line.
Also applies to: 120-122, 171-174
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/brev-web-ui-quickstart.md` around lines 82 - 84, Reflow the prose so each sentence sits on its own source line: locate the paragraph that begins "Direct chat interface for talking to your agent. This is where you start. The agent reads your workspace files and responds using Nemotron-3-Super-120B via NVIDIA Cloud." and break it so each sentence is one line, and apply the same one-sentence-per-line fix to the other multi-sentence blocks noted (the paragraphs around the ranges referenced as 120-122 and 171-174); preserve original wording and punctuation, do not introduce line breaks inside sentences or change sentence content, only move sentence boundaries to separate lines for diff readability.
17-191: Remove numbering/colons from section titles.Headings like “Step 1: …” violate the title format rule.
As per coding guidelines, do not number section titles and do not use colons in titles.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/brev-web-ui-quickstart.md` around lines 17 - 191, Update all headings that include "Step" numbers or colons to plain, unnumbered titles and remove colons; for example change "Step 1: Get Your NVIDIA API Key" to "Get Your NVIDIA API Key", "Step 2: Deploy NemoClaw on Brev" to "Deploy NemoClaw on Brev", "Step 3: Configure Your Agent (3 Steps)" to "Configure Your Agent" and the subheadings "Step 1 of 3 -- Connect to AI", "Step 2 of 3 -- Setup", "Step 3 of 3 -- Launch" to "Connect to AI", "Setup", and "Launch" respectively, and similarly remove numbering/colons from "Step 4: Understand the Dashboard", "Step 5: Have Your First Conversation", "Step 6: Tell the Agent Who You Are", and "Step 7: Stop Your Instance When Done"; ensure you only modify the heading lines (these exact strings) and preserve the body text.
🤖 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/get-started/brev-web-ui-quickstart.md`:
- Around line 6-8: Replace the Markdown blockquote/bold callout starting with
"**Note:** This guide covers the Brev web UI flow..." with a MyST admonition by
wrapping the same text in a :::{note} ... ::: block; ensure you keep the exact
callout content and link to "Deploy to a Remote GPU Instance" unchanged, i.e.,
change the bolded/blockquote line to a MyST :::{note} admonition containing the
same message and closing :::.
- Around line 1-3: This page starts with the H1 "# Get Started with NemoClaw on
Brev (Web UI)" and is missing the required YAML frontmatter and SPDX header; add
a YAML frontmatter block above the H1 containing the required fields: title,
description, keywords, topics, tags, content type, difficulty, audience, and
status (populate appropriate values for NemoClaw/Brev), then immediately after
the closing frontmatter add the SPDX license header block (e.g.,
SPDX-License-Identifier: <license>) before the page body so the document
includes both metadata and the license header.
- Line 66: Replace every plain fenced code block delimiter (``` ) with a
language-specified fence (e.g., ```text, ```bash, or ```json as appropriate) for
the occurrences at the shown locations; locate the three backtick-only fences
(the one at the shown range and the other instances around lines 107 and 125)
and add the correct language label matching the snippet content (use "text" for
message/output examples, "bash" for shell commands, etc.) so static analysis and
docs rendering correctly detect the block language.
---
Nitpick comments:
In `@docs/get-started/brev-web-ui-quickstart.md`:
- Line 120: The prose currently references tokens like USER.md, brev.nvidia.com,
and build.nvidia.com without inline code formatting; update the doc text so
every instance of file names, hostnames, CLI commands, flags, parameter names
and literal values (e.g., USER.md, `brev.nvidia.com`, `build.nvidia.com`) are
wrapped in inline code formatting; scan the surrounding paragraphs (including
the other noted instances around lines 171 and 178) and replace plain
occurrences with inline code-formatted equivalents to follow the guideline.
- Around line 191-196: The final section currently titled "## Related Topics"
should be renamed and restructured to the required page footer format by
replacing the "## Related Topics" header with "## Next Steps" and keeping the
existing links (Quickstart, Deploy to a Remote GPU Instance, Set Up the Telegram
Bridge, Monitor Sandbox Activity) under that header; update any surrounding copy
to match the project's page structure conventions (header text and link
order/format) so the page includes a bottom "Next Steps" section linking the
related pages.
- Line 34: Update the documentation language to present tense by replacing
future-tense phrases like "You will see" and "The agent will ..." with
present-tense equivalents such as "You see" and "The agent ...", e.g., update
the sentence at the NemoClaw setup line that currently reads "You will see the
NemoClaw setup page showing:" to "You see the NemoClaw setup page showing:";
make the same present-tense edits for the other occurrences flagged (lines
containing the phrases at 64, 111, and 132) to ensure all descriptions of
current behavior use present tense.
- Around line 82-84: Reflow the prose so each sentence sits on its own source
line: locate the paragraph that begins "Direct chat interface for talking to
your agent. This is where you start. The agent reads your workspace files and
responds using Nemotron-3-Super-120B via NVIDIA Cloud." and break it so each
sentence is one line, and apply the same one-sentence-per-line fix to the other
multi-sentence blocks noted (the paragraphs around the ranges referenced as
120-122 and 171-174); preserve original wording and punctuation, do not
introduce line breaks inside sentences or change sentence content, only move
sentence boundaries to separate lines for diff readability.
- Around line 17-191: Update all headings that include "Step" numbers or colons
to plain, unnumbered titles and remove colons; for example change "Step 1: Get
Your NVIDIA API Key" to "Get Your NVIDIA API Key", "Step 2: Deploy NemoClaw on
Brev" to "Deploy NemoClaw on Brev", "Step 3: Configure Your Agent (3 Steps)" to
"Configure Your Agent" and the subheadings "Step 1 of 3 -- Connect to AI", "Step
2 of 3 -- Setup", "Step 3 of 3 -- Launch" to "Connect to AI", "Setup", and
"Launch" respectively, and similarly remove numbering/colons from "Step 4:
Understand the Dashboard", "Step 5: Have Your First Conversation", "Step 6: Tell
the Agent Who You Are", and "Step 7: Stop Your Instance When Done"; ensure you
only modify the heading lines (these exact strings) and preserve the body text.
🪄 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: 7a44fc7a-dfc1-4e94-b240-558ef9141dc6
📒 Files selected for processing (1)
docs/get-started/brev-web-ui-quickstart.md
Updated the quickstart guide for NemoClaw on Brev web UI, improving formatting and clarity.
wscurran
added
documentation
|
✨ Thanks for submitting this PR that adds a new getting started guide for running NemoClaw using the Brev web UI. This proposes a way to improve the user experience with the Brev web UI by providing a clear and concise guide for first-time users. |
|
Thank you for submitting the doc PR. Please fix the doc build by registering the new page to index.md. You have marked that you've run make docs for doc build testing, but the build would have finished with warnings or have failed, based on the changes in the PR. And also please provide a proper DCO signoff. Lastly, please read the docs/CONTRIBUTING.md and follow the style guide. There's the skill for updating docs following the contributing guide at https://github.com/NVIDIA/NemoClaw/tree/main/.agents/skills/nemoclaw-contributor-update-docs. If you have an agent, it's highly recommended to run the skill. |
- Updated frontmatter to match NVIDIA template format - Fixed SPDX license header to correct NVIDIA format - Removed step numbering from headings - Fixed future tense to present tense throughout - Added code block language labels - Changed Related Topics to Next Steps - Fixed gateway and sandbox capitalization Signed-off-by: Kunchala Hema Sai Venkat Chandra Kumar <kumarchanduk@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
docs/get-started/brev-web-ui-quickstart.md (4)
40-47: Add an intro sentence at the start of each section before lists/steps.Several sections begin directly with steps or bullet-style entries instead of a short introductory sentence, which breaks the docs page-structure rule.
As per coding guidelines, in
docs/**/*.md, H2/H3 sections must start with an introductory sentence.Also applies to: 53-61, 66-71, 194-212
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/brev-web-ui-quickstart.md` around lines 40 - 47, The "Get Your NVIDIA API Key" section (the H2 titled "Get Your NVIDIA API Key") and the other referenced sections must start with a short introductory sentence before the numbered list; update each H2/H3 in docs/**/*.md (including the sections at the ranges noted: lines 40-47, 53-61, 66-71, 194-212) to add one brief lead-in sentence describing the purpose of the steps (e.g., "Follow these steps to generate an NVIDIA API key.") placed immediately below the heading and above the list so the section follows the docs page-structure rule.
108-132: Replace bold pseudo-headings with proper headings or structured lists.Using repeated bold labels like
**Chat.**,**Control.**, and troubleshooting prompts as bold lines reads like formatting emphasis rather than structure.As per coding guidelines, bold should be reserved for UI labels/parameters/warnings, and LLM-style bold overuse should be flagged.
Also applies to: 194-208
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/brev-web-ui-quickstart.md` around lines 108 - 132, Replace the repeated bold pseudo-headings ("Chat.", "Control.", "Agent.", "Settings.") with proper section headings or structured lists so they read as document structure rather than emphasis; use real headings (e.g., H2/H3) for those section titles and keep bold reserved for UI labels or warnings inside items like "Channels", "Instances", etc.; also update the other occurrence around the "troubleshooting prompts" area referenced (the block around lines showing similar bold labels) to follow the same heading/list structure and ensure consistency in formatting.
35-37: End sentence-style list items with periods.These bullets are sentence-style content but do not consistently end with periods.
As per coding guidelines, every sentence in docs should end with a period.
Also applies to: 57-60
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/brev-web-ui-quickstart.md` around lines 35 - 37, The listed sentence-style bullets are missing terminal periods; update each sentence-style list item to end with a period—specifically add a period to "A free Brev account at [brev.nvidia.com](https://brev.nvidia.com)." and "A free NVIDIA API key from [build.nvidia.com](https://build.nvidia.com)." and also ensure the sentence-style items referenced at lines 57-60 end with periods as well.
29-29: Avoid superlative wording in docs prose.“The fastest way” is marketing-style wording; use neutral functional wording instead. LLM pattern detected.
As per coding guidelines, superlatives (for example “powerful,” “seamless,” “fastest”) should be avoided in docs prose.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/brev-web-ui-quickstart.md` at line 29, Replace the marketing phrasing in the sentence "This guide covers the Brev web UI flow, which is the fastest way to try NemoClaw." with neutral documentation language; for example, change it to "This guide covers the Brev web UI flow, a quick way to try NemoClaw." Update the line in brev-web-ui-quickstart.md so the sentence no longer uses superlatives like "the fastest" and instead uses neutral wording such as "a quick way" or "a convenient way."
🤖 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/get-started/brev-web-ui-quickstart.md`:
- Around line 18-21: Replace the existing HTML-comment SPDX block with the
exact, repo-required SPDX header string and formatting at the very top of the
file; remove the HTML comment markers and ensure the header uses the precise
text and year range the guideline mandates (not the current `2025-2026`),
matching the exact capitalization and SPDX-License-Identifier token so the file
`brev-web-ui-quickstart.md` conforms to the repository rule.
- Line 23: The new "Get Started with NemoClaw on Brev (Web UI)" page is missing
from the docs navigation; open the toctree block named "Get Started" in
docs/index.md (the toctree entries around the block labeled lines ~295-301) and
add the entry Brev Web UI <get-started/brev-web-ui-quickstart> to that list so
the new page is registered in the Get Started navigation.
---
Nitpick comments:
In `@docs/get-started/brev-web-ui-quickstart.md`:
- Around line 40-47: The "Get Your NVIDIA API Key" section (the H2 titled "Get
Your NVIDIA API Key") and the other referenced sections must start with a short
introductory sentence before the numbered list; update each H2/H3 in
docs/**/*.md (including the sections at the ranges noted: lines 40-47, 53-61,
66-71, 194-212) to add one brief lead-in sentence describing the purpose of the
steps (e.g., "Follow these steps to generate an NVIDIA API key.") placed
immediately below the heading and above the list so the section follows the docs
page-structure rule.
- Around line 108-132: Replace the repeated bold pseudo-headings ("Chat.",
"Control.", "Agent.", "Settings.") with proper section headings or structured
lists so they read as document structure rather than emphasis; use real headings
(e.g., H2/H3) for those section titles and keep bold reserved for UI labels or
warnings inside items like "Channels", "Instances", etc.; also update the other
occurrence around the "troubleshooting prompts" area referenced (the block
around lines showing similar bold labels) to follow the same heading/list
structure and ensure consistency in formatting.
- Around line 35-37: The listed sentence-style bullets are missing terminal
periods; update each sentence-style list item to end with a period—specifically
add a period to "A free Brev account at
[brev.nvidia.com](https://brev.nvidia.com)." and "A free NVIDIA API key from
[build.nvidia.com](https://build.nvidia.com)." and also ensure the
sentence-style items referenced at lines 57-60 end with periods as well.
- Line 29: Replace the marketing phrasing in the sentence "This guide covers the
Brev web UI flow, which is the fastest way to try NemoClaw." with neutral
documentation language; for example, change it to "This guide covers the Brev
web UI flow, a quick way to try NemoClaw." Update the line in
brev-web-ui-quickstart.md so the sentence no longer uses superlatives like "the
fastest" and instead uses neutral wording such as "a quick way" or "a convenient
way."
🪄 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: 297644c5-924b-43ee-9102-764599a22211
📒 Files selected for processing (1)
docs/get-started/brev-web-ui-quickstart.md
Signed-off-by: Kunchala Hema Sai Venkat Chandra Kumar <kumarchanduk@gmail.com>
|
Thank you for the detailed feedback @miyoungc . I have pushed the following fixes:
Please let me know if anything else needs to be addressed. |
|
@hemachandra666 Thank you. The DCO check is still failing. Would you provide the correct DCO signoff? Might be a formatting issue. Expected format: Signed-off-by: Your Name your-email@example.com |
|
Thank you for the clarification, @miyoungc Here is the DCO signoff in the correct format: Signed-off-by: Kunchala Hema Sai Venkat Chandra Kumar kumarchanduk@gmail.com |
wscurran
added
the
status: rfr
| ## Troubleshooting | ||
|
|
||
| **The Deploy NemoClaw button is not visible.** | ||
| Make sure you are signed in to `brev.nvidia.com`. | ||
| The banner appears on the GPUs page. | ||
| If you do not see it, try refreshing the page or navigating directly to the NemoClaw tab in the top navigation. | ||
|
|
||
| **API key not accepted.** | ||
| Make sure your key starts with `nvapi-` and was copied in full. | ||
| Keys from `build.nvidia.com` are free and do not require a paid plan. | ||
|
|
||
| **Agent takes more than 5 minutes to deploy.** | ||
| This can happen during periods of high demand on Brev. | ||
| The Cloudflare quota warning at the top of the Brev page may affect deployment time. | ||
| Try again after a few minutes. | ||
|
|
||
| **OpenClaw dashboard shows a blank chat.** | ||
| This is normal on first launch. | ||
| The agent reads its workspace files during the first session startup. | ||
| Type a message and wait a few seconds for the first response. |
There was a problem hiding this comment.
Please move these to the Troubleshooting page.
| **Add a new skill.** | ||
| Go to **Skills** and browse available skills, or use the built-in Skill-Creator to build a custom skill. | ||
|
|
||
| **Schedule a recurring task.** | ||
| Go to **Cron Jobs** to set up tasks the agent runs automatically, such as a daily email check or calendar reminder. |
There was a problem hiding this comment.
We don't need to re-document what should be documented in the upstream OpenClaw documentation. It'll drift.
| ## Understand the Dashboard | ||
|
|
||
| The OpenClaw gateway dashboard has the following sections. | ||
|
|
||
| **Chat.** | ||
| Direct chat interface for talking to your agent. | ||
| This is where you start. | ||
| The agent reads your workspace files and responds using Nemotron-3-Super-120B via NVIDIA Cloud. | ||
|
|
||
| **Control.** | ||
|
|
||
| - **Overview** -- Agent health and status. | ||
| - **Channels** -- Connect to Slack, Telegram, or Discord. | ||
| - **Instances** -- Running agent instances. | ||
| - **Sessions** -- Conversation history. | ||
| - **Usage** -- Token and API usage. | ||
| - **Cron Jobs** -- Schedule recurring agent tasks. | ||
|
|
||
| **Agent.** | ||
|
|
||
| - **Agents** -- Manage agent profiles. | ||
| - **Skills** -- Add new capabilities to your agent. | ||
| - **Nodes** -- Multi-agent node configuration. | ||
|
|
||
| **Settings.** | ||
|
|
||
| - **Config** -- Agent configuration. | ||
| - **Debug** -- Debug logs and diagnostics. |
There was a problem hiding this comment.
We don't need to re-document what should be documented in the upstream OpenClaw documentation. It'll drift.
There was a problem hiding this comment.
@miyoungc Thank you for the detailed review. I have made the following changes:
- Moved the Brev web UI page to the Deployment section in index.md
- Removed the Troubleshooting section from the quickstart guide
- Removed the Dashboard section from the quickstart guide
- Removed the Add a new skill and Schedule a recurring task paragraphs from What to Try Next
- Applied the suggested change for Prerequisites wording
Please let me know if anything else needs to be addressed.
Co-authored-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Kunchala Hema Sai Venkat Chandra Kumar <kumarchanduk@gmail.com>
…enClaw sections Signed-off-by: Kunchala Hema Sai Venkat Chandra Kumar <kumarchanduk@gmail.com>
Co-authored-by: Miyoung Choi <miyoungc@nvidia.com>
miyoungc
left a comment
miyoungc
left a comment
There was a problem hiding this comment.
Thank you for incorporating all the feedback! Approving.
3 participants
docs(get-started): add Brev web UI quickstart guide
Summary
Adds a new getting started guide for running NemoClaw using the Brev
web UI. The existing deploy-to-remote-gpu guide covers the deprecated
CLI-based nemoclaw deploy flow. This guide covers the new one-click
web experience on brev.nvidia.com that requires zero local installation.
Tested end-to-end on April 27, 2026.
Related Issue
None
Changes
Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)AI Disclosure
Signed-off-by: Kunchala Hema Sai Venkat Chandra Kumar kumarchanduk@gmail.com
Summary by CodeRabbit