Skip to content

docs(contributing): route community solutions#6775

Merged
miyoungc merged 1 commit into
mainfrom
codex/docs-community-contribution-guidance
Jul 13, 2026
Merged

docs(contributing): route community solutions#6775
miyoungc merged 1 commit into
mainfrom
codex/docs-community-contribution-guidance

Conversation

@miyoungc

@miyoungc miyoungc commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Summary

Route independent third-party solutions, custom integrations, images, and end-to-end examples through a canonical Community Solutions resource instead of presenting them as supported NemoClaw product surfaces. Add an explicit product-scope gate so contributors and reviewers do not treat working code or green CI as product approval.

Changes

  • Add docs/resources/community-contributions.mdx with canonical-versus-community contribution criteria and promotion guidance.
  • Replace direct community repository links in user documentation and navigation with the new Resources page for all agent variants.
  • Update contributor guides and AGENTS.md with product-scope and ownership requirements.
  • Make product-scope approval a human hard gate in the maintainer-day review workflow, independent of engineering checks and automated review recommendations.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification: The change is documentation and maintainer guidance only; the repository skills-frontmatter test still passes 25/25.
  • Docs updated for user-facing behavior changes
  • Docs not applicable — justification:
  • Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging)
  • Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification:
  • Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue:

Verification

  • PR description includes the DCO sign-off declaration and every commit appears as Verified in GitHub
  • Normal pre-commit, commit-msg, and pre-push hooks passed, or npm run check:diff passed when hooks were skipped or unavailable
  • Targeted behavior tests pass for the current change set, or tests are marked not applicable above — command/result or justification: npx vitest run test/skills-frontmatter.test.ts passed 25/25; behavior tests are not applicable to prose guidance.
  • Applicable broad gate passed — npm test for broad runtime/test-harness changes; npm run check for repo-wide validation/coverage changes — command/result:
  • Quality Gates section completed with required justifications or waivers
  • No secrets, API keys, or credentials committed
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Signed-off-by: Miyoung Choi miyoungc@nvidia.com

Summary by CodeRabbit

  • New Features

    • Added a Community Solutions page explaining contribution scope, review criteria, and promotion paths.
    • Added guidance for distinguishing supported product surfaces from community contributions.
  • Documentation

    • Updated contribution, maintainer, and review guidance to require product-scope approval before establishing supported integrations or workflows.
    • Added explicit approval gates and stop conditions for undocumented product decisions.
    • Replaced external community links with the internal Community Solutions resource throughout the documentation.

@miyoungc miyoungc added the area: docs Documentation, examples, guides, or docs build label Jul 13, 2026
@miyoungc miyoungc self-assigned this Jul 13, 2026
@copy-pr-bot

copy-pr-bot Bot commented Jul 13, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This PR establishes product-scope approval as a human merge gate, updates contributor and maintainer guidance, adds a Community Solutions documentation page, and redirects existing community-related documentation links to that page.

Changes

Product Scope Governance

Layer / File(s) Summary
Product-scope policy
AGENTS.md, CONTRIBUTING.md, docs/CONTRIBUTING.md
Defines product-scope approval requirements, accepted decision evidence, ownership expectations, and routing for unsupported integrations and solutions.
Maintainer merge gates
.agents/skills/nemoclaw-maintainer-day/*
Adds product-scope approval as a human gate separate from deterministic checks and updates stop-and-ask guidance.
Community Solutions resource
docs/resources/community-contributions.mdx
Documents canonical versus community contribution scope, promotion through discussion, and reviewer checks.
Documentation routing updates
docs/about/*, docs/index.mdx, docs/index.yml, docs/network-policy/*
Replaces external community links with the internal Community Solutions documentation page across overview, navigation, and integration content.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested labels: chore

Suggested reviewers: zyang-dev, cv, ericksoa, chengjiew, kagura-agent

🚥 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 clearly matches the main change: routing community solutions through docs and contribution guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docs-community-contribution-guidance

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

@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

E2E Advisor Recommendation

Required E2E: None
Optional E2E: None

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

  • None. No E2E jobs are recommended because this is documentation and agent-guidance only. It does not change installer or onboarding execution, sandbox lifecycle, credentials, security enforcement, network-policy assets, inference routing, deployment behavior, or assistant flows. Validate documentation rendering and links with the docs checks instead.

Optional E2E

  • None.

New E2E recommendations

  • None.

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — No blocking findings

Merge posture: No blocking advisor findings
Primary next action: No advisor follow-up required beyond maintainer review.
Findings: 0 required · 0 warnings · 0 optional suggestions
Since last review: 0 prior items resolved · 0 still apply · 0 new items found

Workflow run details

This is an automated review. Required findings need action before merge. Warnings and optional suggestions do not require a response or follow-up. A human maintainer makes the final merge decision.

@miyoungc
miyoungc marked this pull request as ready for review July 13, 2026 17:07
@miyoungc miyoungc added area: project-management Taxonomy, triage, workflow, roadmap, or project process v0.0.82 Release target labels Jul 13, 2026

@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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.agents/skills/nemoclaw-maintainer-day/MERGE-GATE.md:
- Line 15: Update the conflict-status wording in both
.agents/skills/nemoclaw-maintainer-day/MERGE-GATE.md at line 15 and
.agents/skills/nemoclaw-maintainer-day/PR-REVIEW-PRIORITIES.md at line 14 to use
the same precise contract, explicitly accepting CLEAN, HAS_HOOKS, and UNSTABLE
or stating that the conflict gate must pass.

In `@docs/CONTRIBUTING.md`:
- Line 28: Update both Community Solutions links in the contributing
documentation to use the published resources/community-contributions route,
removing the .mdx extension while preserving the existing link text and
destinations.
🪄 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: 2cc53023-65f6-4d78-9479-d3214b812067

📥 Commits

Reviewing files that changed from the base of the PR and between 3de1de6 and 044047c.

📒 Files selected for processing (14)
  • .agents/skills/nemoclaw-maintainer-day/MERGE-GATE.md
  • .agents/skills/nemoclaw-maintainer-day/PR-REVIEW-PRIORITIES.md
  • .agents/skills/nemoclaw-maintainer-day/SKILL.md
  • AGENTS.md
  • CONTRIBUTING.md
  • docs/CONTRIBUTING.md
  • docs/about/ecosystem-deepagents.mdx
  • docs/about/ecosystem-hermes.mdx
  • docs/about/ecosystem.mdx
  • docs/about/overview.mdx
  • docs/index.mdx
  • docs/index.yml
  • docs/network-policy/integration-policy-examples.mdx
  • docs/resources/community-contributions.mdx

1. **Product scope approved** — confirm that the PR implements existing supported behavior or a linked, accepted product decision. Do not approve a new integration, solution, third-party stack, custom image, or canonical documentation surface merely because it works. Require defined ownership, lifecycle, compatibility, security, and validation expectations. Route independent solutions through [Community Solutions](../../../docs/resources/community-contributions.mdx).
2. **Contributor compliance** — the PR body contains the contributor's `Signed-off-by:` declaration and every PR commit appears as `Verified` in GitHub. Reject noncompliant PRs; maintainers do not repair contributor history.
3. **CI green** — all required checks in `statusCheckRollup`.
4. **No conflicts** — `mergeStateStatus` clean.

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.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Use one precise conflict-status contract in both maintainer guides.

The checker accepts CLEAN, HAS_HOOKS, and UNSTABLE as 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
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/nemoclaw-maintainer-day/MERGE-GATE.md at line 15, Update the
conflict-status wording in both
.agents/skills/nemoclaw-maintainer-day/MERGE-GATE.md at line 15 and
.agents/skills/nemoclaw-maintainer-day/PR-REVIEW-PRIORITIES.md at line 14 to use
the same precise contract, explicitly accepting CLEAN, HAS_HOOKS, and UNSTABLE
or stating that the conflict gate must pass.

Comment thread docs/CONTRIBUTING.md
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).

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.

🎯 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' || true

Repository: NVIDIA/NemoClaw

Length of output: 5165


Use the published route for Community Solutions.

resources/community-contributions is the published slug, so link to that route instead of resources/community-contributions.mdx in both spots.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/CONTRIBUTING.md` at line 28, Update both Community Solutions links in
the contributing documentation to use the published
resources/community-contributions route, removing the .mdx extension while
preserving the existing link text and destinations.

Sources: Coding guidelines, Path instructions

@miyoungc
miyoungc merged commit 9b9f88c into main Jul 13, 2026
52 of 53 checks passed
@miyoungc
miyoungc deleted the codex/docs-community-contribution-guidance branch July 13, 2026 17:20
cv pushed a commit that referenced this pull request Jul 14, 2026
<!-- markdownlint-disable MD041 -->
## Summary

Release-prep documentation for v0.0.82 now summarizes user-facing
changes merged since v0.0.81.
It also closes stale wording in the stopped-sandbox backup,
snapshot-clone, Ollama selection, and custom-policy authoring guidance.

## Changes

- Add the `v0.0.82` section to `docs/about/release-notes.mdx` with links
to the focused user guides.
- Document that snapshot clones receive a destination-owned dashboard
port before destructive replacement begins.
- Align `backup-all` guidance with eligible stopped Docker-driver
sandboxes that NemoClaw starts temporarily.
- Describe the running and stopped Ollama menu states without claiming
one fixed label.
- Document runtime rejection of catch-all hosts in custom policy files.

### Source summary

- [#6748](#6748) ->
`docs/about/release-notes.mdx`, `docs/manage-sandboxes/lifecycle.mdx`,
and `docs/reference/commands.mdx`: Summarize non-destructive sandbox
`stop` and `start` commands.
- [#6723](#6723) ->
`docs/about/release-notes.mdx`,
`docs/manage-sandboxes/backup-restore.mdx`, and
`docs/reference/commands.mdx`: Record temporary startup and cleanup for
eligible stopped-sandbox backups.
- [#6749](#6749) ->
`docs/about/release-notes.mdx` and
`docs/manage-sandboxes/backup-restore.mdx`: Document destination-owned
dashboard ports for snapshot clones.
- [#6764](#6764) ->
`docs/about/release-notes.mdx`: Summarize installer handling of
route-only onboarding placeholders.
- [#6771](#6771) ->
`docs/about/release-notes.mdx`, `docs/inference/set-up-vllm.mdx`,
`docs/inference/choose-inference-provider.mdx`,
`docs/reference/commands.mdx`, and
`docs/reference/platform-support.mdx`: Summarize managed-vLLM storage
gates, immutable image digests, and the explicit override boundary.
- [#6759](#6759) ->
`docs/about/release-notes.mdx`: Record early, actionable OpenShell
gateway-port conflict diagnostics.
- [#6753](#6753) ->
`docs/about/release-notes.mdx` and `docs/inference/set-up-ollama.mdx`:
Document truthful running and stopped Ollama menu states.
- [#6776](#6776) ->
`docs/about/release-notes.mdx`: Summarize proxy-independent loopback
readiness checks.
- [#6769](#6769) ->
`docs/about/release-notes.mdx`: Record compatible endpoint and agent
guidance when Chat Completions is unavailable.
- [#6730](#6730) ->
`docs/about/release-notes.mdx`: Summarize bounded reuse of an eligible
successful Chat Completions check.
- [#6768](#6768) ->
`docs/about/release-notes.mdx`: Record route-reservation repair during
resumed onboarding.
- [#6742](#6742) ->
`docs/about/release-notes.mdx`: Summarize pre-mutation resolution of
secret-free sandbox create intent.
- [#6721](#6721) ->
`docs/about/release-notes.mdx` and
`docs/get-started/quickstart-langchain-deepagents-code.mdx`: Record
bounded cleanup of completed managed Deep Agents headless sessions.
- [#6731](#6731) ->
`docs/about/release-notes.mdx` and
`docs/network-policy/customize-network-policy.mdx`: Document runtime
rejection of catch-all custom-policy destinations.
- [#6729](#6729) ->
`docs/about/release-notes.mdx` and `docs/get-started/prerequisites.mdx`:
Record the Node.js 22.19 minimum.
- [#6735](#6735) ->
`docs/about/release-notes.mdx` and
`docs/reference/platform-support.mdx`: Summarize the Ubuntu 26.04
userspace contract without claiming pending host or live validation.
- [#6775](#6775) ->
`docs/about/release-notes.mdx` and
`docs/resources/community-contributions.mdx`: Route independent
solutions outside canonical supported-product documentation.
- [#6740](#6740) ->
`docs/about/release-notes.mdx`: Summarize the semantic
dependency-upgrade contributor workflow.
- [#6777](#6777) ->
`docs/about/release-notes.mdx` and `docs/CONTRIBUTING.md`: Summarize the
route-safe documentation-refactor workflow.
- [#6741](#6741) ->
`docs/about/release-notes.mdx` and
`docs/security/openclaw-2026.6.10-dependency-review.md`: Summarize
reviewed npm archive verification and audit enforcement.
- [#6739](#6739) ->
`docs/about/release-notes.mdx` and
`docs/security/openclaw-2026.6.10-dependency-review.md`: Record the
locked offline dependency graph for the managed OpenClaw WeChat runtime.
- [#6737](#6737) ->
`docs/about/release-notes.mdx`: Record removal of the messaging build
plan from final OpenClaw and Hermes image environments.
- [#6733](#6733) ->
`docs/about/release-notes.mdx`: Summarize cached plugin dependency
layers for source and blueprint rebuilds.

### Skipped from docs-skip

- None. No commit or changed path in `v0.0.81..origin/main` matched
`openclaw-sandbox-permissive.yaml` or `config-show`, and the drafted
content contains none of the configured skip terms.

## Type of Change

- [ ] Code change (feature, bug fix, or refactor)
- [ ] Code change with doc updates
- [x] Doc only (prose changes, no code sample modifications)
- [ ] Doc only (includes code sample changes)

## Quality Gates

- [ ] Tests added or updated for changed behavior
- [ ] Existing tests cover changed behavior — justification:
- [x] Tests not applicable — justification: This is a documentation-only
release-prep update; behavior is protected by the merged source PRs, and
the documentation build validates the changed routes and agent variants.
- [x] Docs updated for user-facing behavior changes
- [ ] Docs not applicable — justification:
- [ ] Sensitive paths changed (security, policy, credentials, preflight,
onboarding, inference, runner, sandbox, or messaging)
- [ ] Sensitive-path review completed or maintainer-approved waiver
recorded — reviewer/approval link/justification:
- [ ] Non-success, skipped, or missing CI check accepted by maintainer —
check name, approval link, and follow-up issue:

## Verification

- [x] PR description includes the DCO sign-off declaration and every
commit appears as `Verified` in GitHub
- [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or
`npm run check:diff` passed when hooks were skipped or unavailable
- [x] Targeted behavior tests pass for the current change set, or tests
are marked not applicable above — tests are not applicable for this
documentation-only change.
- [ ] Applicable broad gate passed — `npm test` for broad
runtime/test-harness changes; `npm run check` for repo-wide
validation/coverage changes — command/result: not run for this
documentation-only change.
- [x] Quality Gates section completed with required justifications or
waivers
- [x] No secrets, API keys, or credentials committed
- [ ] `npm run docs` builds without warnings (doc changes only) — 0
errors; two pre-existing Fern warnings remain.
- [x] Doc pages follow the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md)
(doc changes only)
- [ ] New doc pages include SPDX header and frontmatter (new pages only)
— no new pages.

---
Signed-off-by: Charan Jagwani <cjagwani@nvidia.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated release notes with improvements to sandbox recovery,
onboarding, session management, policy validation, storage checks, and
system requirements.
  * Clarified Ollama setup instructions and status labels.
* Documented safer snapshot restoration, including dedicated ports and
protection against destructive failures.
* Expanded `backup-all` coverage to include eligible stopped sandboxes.
* Added guidance rejecting broad or catch-all network destinations in
custom policies.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Charan Jagwani <cjagwani@nvidia.com>
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 area: project-management Taxonomy, triage, workflow, roadmap, or project process v0.0.82 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants