Skip to content

docs: surface README community paths (Fixes #3827)#4339

Open
deepujain wants to merge 1 commit into
NVIDIA:mainfrom
deepujain:docs/3827-readme-community-paths
Open

docs: surface README community paths (Fixes #3827)#4339
deepujain wants to merge 1 commit into
NVIDIA:mainfrom
deepujain:docs/3827-readme-community-paths

Conversation

@deepujain
Copy link
Copy Markdown
Contributor

@deepujain deepujain commented May 27, 2026

Summary

Adds an early README "Get Involved" block so new users and contributors can quickly find the right channel for questions, bugs, feature proposals, contributing, roadmap context, and security reports.

Fixes #3827.

Changes

  • Added a top-level channel matrix near the beginning of README.md.
  • Linked contribution guidance, good first issue, GitHub Discussions, Discord, Issues, open milestones, SECURITY.md, and CODE_OF_CONDUCT.md.
  • Updated the later Community section to point back to the new front-door matrix.
  • Added a README regression test to keep those paths visible near the top.

Testing

  • npm run build:cli
  • npm run typecheck:cli
  • npm run docs
  • npx vitest run test/readme-community-links.test.ts

Evidence it works

  • Fern docs validation completed with 0 errors.
  • The README test confirms the new Get Involved section appears before Getting Started and includes the required community, contribution, roadmap, conduct, and security links.

Summary by CodeRabbit

  • Documentation

    • Introduced new "Get Involved" section with a comprehensive community and help channel matrix for questions, bug reports, feature proposals, contributions, project milestones, and security reporting.
    • Updated Community section messaging to direct readers to the new Get Involved guidance.
    • Added Code of Conduct reference.
  • Tests

    • Added automated tests to verify community documentation structure and required reference links are present.

Review Change Stack

Fixes NVIDIA#3827

Signed-off-by: Deepak Jain <deepujain@gmail.com>
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 27, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: ce77b677-4fb8-45da-88d0-c7bca4abf954

📥 Commits

Reviewing files that changed from the base of the PR and between e139dbc and 7ac159a.

📒 Files selected for processing (2)
  • README.md
  • test/readme-community-links.test.ts

📝 Walkthrough

Walkthrough

This PR restructures the NemoClaw README to surface community participation and support channels earlier and more prominently. A new "Get Involved" section presents a channel matrix directing users to appropriate resources (discussions, Discord, issues, contributing, milestones, security), while the "Community" section is updated to reference this matrix. A test validates the section presence, ordering, and required link content.

Changes

Community Documentation

Layer / File(s) Summary
Get Involved section and community channels update
README.md
New "Get Involved" section introduces a community/support channel matrix mapping user needs to specific links (discussions, Discord, issues, contributing, milestones, security note, Code of Conduct). The "Community" section is updated to reference the matrix instead of prior simpler text.
README community link validation test
test/readme-community-links.test.ts
Vitest test loads the README at runtime, asserts "Get Involved" appears before "Getting Started", and verifies that specific community and security link strings are present between those section headings.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A warren of pathways now guides weary souls,
where questions find home and bug reports have goals,
the README glows brighter with channels so clear—
contributing hearts can now venture right here! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main change: surfacing community paths in the README via a new 'Get Involved' section.
Linked Issues check ✅ Passed All coding requirements from issue #3827 are met: early 'Get Involved' block added with community/security links, channel matrix provided, roadmap link (milestones) included, and README test verifies the structure.
Out of Scope Changes check ✅ Passed All changes are directly related to issue #3827: README updates surface community paths, and the test file ensures these paths remain discoverable.
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 unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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

@wscurran wscurran added documentation Improvements or additions to documentation fix priority: high Important issue that should be resolved in the next release labels May 27, 2026
@wscurran
Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this detailed PR that adds a Get Involved block to the README, making it easier for new users and contributors to find the right channels for questions, bugs, and feature proposals. This proposes a fix for the issue where community paths were not easily accessible, and updates the README to include links to contribution guidance, GitHub Discussions, Discord, Issues, open milestones, SECURITY.md, and CODE_OF_CONDUCT.md.


Related open issues:

@wscurran wscurran self-assigned this May 27, 2026
@wscurran wscurran self-requested a review May 27, 2026 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation fix priority: high Important issue that should be resolved in the next release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): surface contribution, support, and roadmap paths

2 participants