Skip to content

docs: add discord channel to docs site - #416

Merged
miyoungc merged 7 commits into
mainfrom
docs/discord-forum-link
Mar 19, 2026
Merged

docs: add discord channel to docs site#416
miyoungc merged 7 commits into
mainfrom
docs/discord-forum-link

Conversation

@miyoungc

@miyoungc miyoungc commented Mar 19, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Renamed the footer GitHub label to "NemoClaw GitHub" to reinforce project branding across site chrome.
    • Added a "NemoClaw Discord" community link to the site footer, Resources list, and the README “Learn More” section for community support.
    • Added a prominent “Get Help” tip on the troubleshooting page directing users to the Discord channel and GitHub issues for assistance.

@miyoungc miyoungc self-assigned this Mar 19, 2026
@coderabbitai

coderabbitai Bot commented Mar 19, 2026

Copy link
Copy Markdown
Contributor

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: af3ee458-3821-48d6-8a4c-720bb784c7fa

📥 Commits

Reviewing files that changed from the base of the PR and between 776ce21 and a39ae98.

📒 Files selected for processing (4)
  • README.md
  • docs/conf.py
  • docs/index.md
  • docs/reference/troubleshooting.md
✅ Files skipped from review due to trivial changes (3)
  • docs/reference/troubleshooting.md
  • docs/index.md
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/conf.py

📝 Walkthrough

Walkthrough

Updated Sphinx theme icon links in docs/conf.py (renamed GitHub entry and added a Discord entry) and added Discord community references plus a "Get Help" tip across README.md, docs/index.md, and docs/reference/troubleshooting.md.

Changes

Cohort / File(s) Summary
Sphinx theme config
docs/conf.py
Renamed html_theme_options["icon_links"] GitHub item name to "NemoClaw GitHub"; appended a new Discord icon link with "name": "NemoClaw Discord", "url": "https://discord.gg/XFpfPv9Uvx", "icon": "fa-brands fa-discord", "type": "fontawesome".
Top-level docs & index
README.md, docs/index.md
Reworded several "Learn More" link texts in README.md to "Learn …" phrasing and added a Discord community/resource link (https://discord.gg/XFpfPv9Uvx) to both README.md and docs/index.md.
Troubleshooting doc
docs/reference/troubleshooting.md
Inserted a "Get Help" tip/admonition pointing to the NemoClaw Discord (https://discord.gg/XFpfPv9Uvx) and to the project GitHub Issues URL for filing issues.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I hopped through docs with nimble feet,
Tucked a Discord bell where friends will meet.
A GitHub name, a helpful tip in sight,
Links stitched softly, morning bright.
Hooray — community takes flight! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: add discord channel to docs site' directly describes the main change across all modified files—adding Discord community links to documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/discord-forum-link
📝 Coding Plan
  • Generate coding plan for human review comments

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/conf.py`:
- Around line 105-110: Replace the Discord channel URL in the social link
dictionary (the dict with "name": "NVIDIA NemoClaw Discord Forum") so it uses a
public invite URL (e.g., "https://discord.gg/INVITE_CODE") instead of the
channel-specific "https://discord.com/channels/{server_id}/{channel_id}"; update
the "url" value in that dict and, if you still want to reference the channel,
add explanatory documentation elsewhere that instructs users to join via the
invite before navigating to the channel link.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 9e4098f2-bf81-44b6-b1e0-5ea4b8b9565d

📥 Commits

Reviewing files that changed from the base of the PR and between 20a63d0 and 3148697.

📒 Files selected for processing (1)
  • docs/conf.py

Comment thread docs/conf.py
@miyoungc
miyoungc marked this pull request as draft March 19, 2026 16:31
@miyoungc
miyoungc marked this pull request as ready for review March 19, 2026 16:35
@miyoungc
miyoungc merged commit 60992be into main Mar 19, 2026
4 checks passed
Ryuketsukami pushed a commit to Ryuketsukami/NemoClaw that referenced this pull request Mar 24, 2026
* add discord channel to docs

* shorter preview text

* add discord link to more places

* resolve warning

* use invite link

* update url

* nit
jessesanford pushed a commit to jessesanford/NemoClaw that referenced this pull request Mar 24, 2026
* add discord channel to docs

* shorter preview text

* add discord link to more places

* resolve warning

* use invite link

* update url

* nit
mafueee pushed a commit to mafueee/NemoClaw that referenced this pull request Mar 28, 2026
@miyoungc
miyoungc deleted the docs/discord-forum-link branch May 27, 2026 20:52
@wscurran wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance and removed documentation labels Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants