Update Quick Start UI documentation #1156
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
WalkthroughUpdated the UI launching documentation to add explicit WebSocket setup steps and guidance, adjust WebSocket configuration wording (default path Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant User
participant UI as "Web UI"
participant Backend as "Server (HTTP/WebSocket)"
rect rgb(235,245,255)
Note over UI,Backend: WebSocket mode enablement flow (docs describe these steps)
end
User->>UI: Open Settings → enable WebSocket mode
UI->>Backend: Open WebSocket connection (path: /websocket)
Backend-->>UI: WebSocket handshake / stream established
UI-->>User: Stream intermediate results and final output
alt Error
Backend-->>UI: Close/Error
UI-->>User: Show error/notice
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
ericevans-nv
force-pushed
the
doc/updated-ui-documentation
branch
from
bc7c829 to
3326382
Compare
Signed-off-by: Eric Evans <[email protected]>
ericevans-nv
force-pushed
the
doc/updated-ui-documentation
branch
from
3326382 to
0377aa6
Compare
ericevans-nv
added
doc
Signed-off-by: Eric Evans <[email protected]>
![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
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/source/quick-start/launching-ui.md(3 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
{docs/source/**/*.md,**/README.@(md|ipynb)}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
{docs/source/**/*.md,**/README.@(md|ipynb)}: Use the full name “NVIDIA NeMo Agent toolkit” on first use in documentation, then “NeMo Agent toolkit”; in headings use “NeMo Agent Toolkit” (capital T)
Do not use deprecated names (Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq) in documentation unless explicitly referring to deprecated names
Never use “NAT”/“nat” abbreviations in documentation
Documentation must be clear/comprehensive; avoid TODOs/FIXMEs/placeholders; avoid offensive/outdated terms; ensure spelling is correct
Files:
docs/source/quick-start/launching-ui.md
docs/source/**/*.md
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
docs/source/**/*.md: Documentation sources are Markdown files under docs/source
Surround code entities with backticks in docs to avoid Vale false positives
Do not use words listed in ci/vale/styles/config/vocabularies/nat/reject.txt; accepted words in accept.txt are allowed
Files:
docs/source/quick-start/launching-ui.md
{**/*.py,**/*.sh,**/*.md,**/*.toml,**/*.y?(a)ml,**/*.json,**/*.txt,**/*.ini,**/*.cfg,**/*.ipynb}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
{**/*.py,**/*.sh,**/*.md,**/*.toml,**/*.y?(a)ml,**/*.json,**/*.txt,**/*.ini,**/*.cfg,**/*.ipynb}: Every file must start with the standard SPDX Apache-2.0 header
Confirm copyright years are up to date when a file is changed
All source files must include the SPDX Apache-2.0 header template (copy from an existing file)
Files:
docs/source/quick-start/launching-ui.md
**/*
⚙️ CodeRabbit configuration file
**/*: # Code Review Instructions
- Ensure the code follows best practices and coding standards. - For Python code, follow
PEP 20 and
PEP 8 for style guidelines.- Check for security vulnerabilities and potential issues. - Python methods should use type hints for all parameters and return values.
Example:def my_function(param1: int, param2: str) -> bool: pass- For Python exception handling, ensure proper stack trace preservation:
- When re-raising exceptions: use bare
raisestatements to maintain the original stack trace,
and uselogger.error()(notlogger.exception()) to avoid duplicate stack trace output.- When catching and logging exceptions without re-raising: always use
logger.exception()
to capture the full stack trace information.Documentation Review Instructions - Verify that documentation and comments are clear and comprehensive. - Verify that the documentation doesn't contain any TODOs, FIXMEs or placeholder text like "lorem ipsum". - Verify that the documentation doesn't contain any offensive or outdated terms. - Verify that documentation and comments are free of spelling mistakes, ensure the documentation doesn't contain any
words listed in the
ci/vale/styles/config/vocabularies/nat/reject.txtfile, words that might appear to be
spelling mistakes but are listed in theci/vale/styles/config/vocabularies/nat/accept.txtfile are OK.Misc. - All code (except .mdc files that contain Cursor rules) should be licensed under the Apache License 2.0,
and should contain an Apache License 2.0 header comment at the top of each file.
- Confirm that copyright years are up-to date whenever a file is changed.
Files:
docs/source/quick-start/launching-ui.md
docs/source/**/*
⚙️ CodeRabbit configuration file
This directory contains the source code for the documentation. All documentation should be written in Markdown format. Any image files should be placed in the
docs/source/_staticdirectory.
Files:
docs/source/quick-start/launching-ui.md
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-10-22T22:02:12.903Z
Learning: Applies to {docs/source/**/*.md,**/README.@(md|ipynb)} : Use the full name “NVIDIA NeMo Agent toolkit” on first use in documentation, then “NeMo Agent toolkit”; in headings use “NeMo Agent Toolkit” (capital T)
📚 Learning: 2025-10-22T22:02:12.903Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-10-22T22:02:12.903Z
Learning: Applies to CHANGELOG.md : Add user-visible changes to CHANGELOG.md under the appropriate section
Applied to files:
docs/source/quick-start/launching-ui.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: CI Pipeline / Check
🔇 Additional comments (6)
docs/source/quick-start/launching-ui.md (6)
111-120: Verify WebSocket instruction formatting and clarity.The step-by-step WebSocket instructions are clear and well-structured. The
:::{important}Sphinx directive is correctly formatted for MyST markdown rendering.Please confirm that the Sphinx directive renders properly in your documentation build pipeline (typically MyST markdown requires proper fence markers). The numbered list formatting and instruction clarity are solid.
79-82: Verify note formatting for documentation build.The
:::noteSphinx directive is properly formatted for MyST markdown. The added context about time-dependent responses is helpful for users.Confirm that the MyST markdown
:::notedirective renders correctly in your documentation build system.
144-144: Code entity formatting is correct.The backticks around
websocketproperly denote it as a code entity, following the documentation guideline for code references.
20-20: Naming conventions are consistently applied.All references to "NeMo Agent toolkit" follow the documented guideline:
- Line 20: First mention uses full name "NVIDIA NeMo Agent toolkit" ✓
- Subsequent body text uses lowercase "NeMo Agent toolkit" ✓
- Headings use capital "NeMo Agent Toolkit" ✓
The references to the official UI repository ("NeMo Agent Toolkit UI" with capital letters) in lines 94-97 are acceptable as they refer to the official product/repository names.
Also applies to: 35-35, 41-45, 51-53, 65-65, 90-92, 94-97
1-16: SPDX header and copyright are current.The Apache-2.0 license header is properly formatted with current copyright year (2025).
125-125: Image references verified and correctly updated.All three new image files exist in
docs/source/_static/(ui_settings_example.png, ui_simple_calculator_example.png, ui_home_page.png), the deprecated images have been removed, and the markdown file correctly references the new filenames at both lines 125 and 161.
|
/merge |
Updates the `docs/source/quick-start/launching-ui.md` documentation to accurately reflect the latest changes from the NeMo-Agent-Toolkit-UI, including enhancing the WebSocket important note with step-by-step instructions, fixing Sphinx directive syntax for proper rendering, and improving overall formatting with proper blank lines for markdown linting compliance. Screenshot updates include renaming `ui_generate_example_settings.png` to `ui_settings_example.png`, renaming `ui_generate_example.png` to `ui_simple_calculator_example.png`, updating `ui_home_page.png` to the latest version, and removing unused screenshots (`ui_generate_example.png`, `ui_generate_example_settings.png`, and `ui_generate_websocket_example.png`) that are no longer referenced in the documentation. All changes ensure the documentation accurately reflects the current state of the NeMo Agent Toolkit UI and matches the official UI repository. ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md). - We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. - Any contribution which contains commits that are not Signed-Off will not be accepted. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. ## Summary by CodeRabbit * **Documentation** * Quick-start launching UI guide updated with a step-by-step WebSocket enablement guide and clearer connection/status guidance * Clarified that WebSocket path defaults to "websocket" and broadened streaming guidance for intermediate results * Added a standalone note that responses may vary with time of day * Replaced/updated UI example images and improved Settings section wording and formatting Authors: - Eric Evans II (https://github.com/ericevans-nv) Approvers: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) - Will Killian (https://github.com/willkill07) URL: NVIDIA#1156 Signed-off-by: Yuchen Zhang <[email protected]>
Updates the `docs/source/quick-start/launching-ui.md` documentation to accurately reflect the latest changes from the NeMo-Agent-Toolkit-UI, including enhancing the WebSocket important note with step-by-step instructions, fixing Sphinx directive syntax for proper rendering, and improving overall formatting with proper blank lines for markdown linting compliance. Screenshot updates include renaming `ui_generate_example_settings.png` to `ui_settings_example.png`, renaming `ui_generate_example.png` to `ui_simple_calculator_example.png`, updating `ui_home_page.png` to the latest version, and removing unused screenshots (`ui_generate_example.png`, `ui_generate_example_settings.png`, and `ui_generate_websocket_example.png`) that are no longer referenced in the documentation. All changes ensure the documentation accurately reflects the current state of the NeMo Agent Toolkit UI and matches the official UI repository. ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md). - We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. - Any contribution which contains commits that are not Signed-Off will not be accepted. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. ## Summary by CodeRabbit * **Documentation** * Quick-start launching UI guide updated with a step-by-step WebSocket enablement guide and clearer connection/status guidance * Clarified that WebSocket path defaults to "websocket" and broadened streaming guidance for intermediate results * Added a standalone note that responses may vary with time of day * Replaced/updated UI example images and improved Settings section wording and formatting Authors: - Eric Evans II (https://github.com/ericevans-nv) Approvers: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) - Will Killian (https://github.com/willkill07) URL: NVIDIA#1156 Signed-off-by: Sangharsh Aglave <[email protected]>
3 participants
Description
Updates the
docs/source/quick-start/launching-ui.mddocumentation to accurately reflect the latest changes from the NeMo-Agent-Toolkit-UI, including enhancing the WebSocket important note with step-by-step instructions, fixing Sphinx directive syntax for proper rendering, and improving overall formatting with proper blank lines for markdown linting compliance. Screenshot updates include renamingui_generate_example_settings.pngtoui_settings_example.png, renamingui_generate_example.pngtoui_simple_calculator_example.png, updatingui_home_page.pngto the latest version, and removing unused screenshots (ui_generate_example.png,ui_generate_example_settings.png, andui_generate_websocket_example.png) that are no longer referenced in the documentation. All changes ensure the documentation accurately reflects the current state of the NeMo Agent Toolkit UI and matches the official UI repository.By Submitting this PR I confirm:
Summary by CodeRabbit