-
Notifications
You must be signed in to change notification settings - Fork 3.1k
docs(contributing): route community solutions #6775
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,17 @@ Update documentation when your change: | |
| - Fixes a bug that the docs describe incorrectly. | ||
| - Changes an API, protocol, or policy schema. | ||
|
|
||
| ## Confirm Product Scope Before Writing Docs | ||
|
|
||
| Canonical documentation describes behavior that NemoClaw has chosen to support and maintain. | ||
| A documentation PR must not establish a new supported integration, solution workflow, custom image, third-party stack, or product surface by itself. | ||
|
|
||
| Technical correctness, successful builds, and working examples are necessary evidence, but they are not product approval. | ||
| Before documenting a new surface, confirm that an accepted issue or design decision defines ownership, compatibility and upgrade expectations, security review, lifecycle support, and validation. | ||
|
|
||
| Route independent solutions, complete use-case examples, and third-party integrations through [Community Solutions](resources/community-contributions.mdx). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win 🧩 Analysis chain🏁 Script executed: #!/bin/bash
set -euo pipefail
printf 'Files:\n'
git ls-files docs/CONTRIBUTING.md docs/index.yml fern/docs.yml | sed 's#^`#-` #'
printf '\nRelevant excerpt from docs/CONTRIBUTING.md:\n'
sed -n '20,40p' docs/CONTRIBUTING.md
printf '\nPublished route mapping search:\n'
rg -n "community-contributions|Community Solutions" docs/index.yml fern/docs.yml docs -g '!**/*.map' -g '!**/*.png' -g '!**/*.jpg' -g '!**/*.svg' || trueRepository: NVIDIA/NemoClaw Length of output: 5165 Use the published route for Community Solutions.
🤖 Prompt for AI AgentsSources: Coding guidelines, Path instructions |
||
| If the correct destination is unclear, request maintainer direction before drafting the page. | ||
|
|
||
| ## Update Docs with Contributor Skills | ||
|
|
||
| If you use an AI coding agent (Cursor, Claude Code, Codex, etc.), the repo includes the `nemoclaw-contributor-update-docs` skill that automates doc work. | ||
|
|
@@ -276,6 +287,9 @@ feat(cli): add policy-add command | |
|
|
||
| When reviewing documentation: | ||
|
|
||
| - Confirm that the page documents an approved and maintained NemoClaw product surface. | ||
| - Do not approve a new integration or solution solely because its instructions work or its checks pass. | ||
| - Route independent third-party solutions to [Community Solutions](resources/community-contributions.mdx) when no product decision establishes core ownership. | ||
| - Check that the style guide rules above are followed. | ||
| - Watch for LLM-generated patterns (excessive bold, em dashes, filler). | ||
| - Verify code examples are accurate and runnable. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Use one precise conflict-status contract in both maintainer guides.
The checker accepts
CLEAN,HAS_HOOKS, andUNSTABLEas passing statuses, but both documents reduce this to “clean.”.agents/skills/nemoclaw-maintainer-day/MERGE-GATE.md#L15-L15: document the accepted statuses or state that the conflict gate must pass..agents/skills/nemoclaw-maintainer-day/PR-REVIEW-PRIORITIES.md#L14-L14: apply the same wording as the merge-gate guide.📍 Affects 2 files
.agents/skills/nemoclaw-maintainer-day/MERGE-GATE.md#L15-L15(this comment).agents/skills/nemoclaw-maintainer-day/PR-REVIEW-PRIORITIES.md#L14-L14🤖 Prompt for AI Agents