Skip to content

feat(skills): add maintainer docs refactor workflow - #6777

Merged
miyoungc merged 2 commits into
mainfrom
codex/maintainer-docs-refactor-skill
Jul 13, 2026
Merged

feat(skills): add maintainer docs refactor workflow#6777
miyoungc merged 2 commits into
mainfrom
codex/maintainer-docs-refactor-skill

Conversation

@miyoungc

@miyoungc miyoungc commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Summary

Add a maintainer skill that turns oversized Fern sections into journey-based, one-topic pages while preserving canonical ownership, variants, routes, anchors, and redirects.
Wire it into skill discovery, release-prep handoff, and docs contributor guidance so remaining sections follow the inference refactor consistently.

Changes

  • Add nemoclaw-maintainer-refactor-docs as a reusable maintainer workflow; remaining sections need consistent information-architecture rules, and one-off edits cannot enforce ownership and route safety across future refactors.
  • Encode the inference-derived structure: choose, set up, operate, validate, then canonical troubleshooting and reference, with provider-specific pages and non-clickable grouping nodes.
  • Require content and anchor inventories, deduplication, variant-aware navigation, direct legacy redirects, release-note/source-reference audits, compact lists, deterministic checks, and independent docs review.
  • Register the skill in the catalog and route structural release-prep work from nemoclaw-contributor-update-docs to the maintainer workflow.
  • Document the workflow in docs/CONTRIBUTING.md; test/skills-frontmatter.test.ts protects the new skill's metadata and discoverability contract.

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: the skill frontmatter test validates checked-in skill metadata and the skill-creator validator confirms the package structure.
  • Tests not applicable — justification:
  • Docs updated for user-facing behavior changes
  • Docs not applicable — justification: this adds an internal maintainer workflow and contributor guidance without changing NemoClaw runtime or user-facing product behavior.
  • 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: skill validator passed; npx vitest run test/skills-frontmatter.test.ts passed 26 tests.
  • Applicable broad gate passed — npm test for broad runtime/test-harness changes; npm run check for repo-wide validation/coverage changes — command/result: not applicable; this is a guidance-only skill and documentation change.
  • 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) — result: passed with 0 errors and one suppressed Fern warning.
  • 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

  • Documentation
    • Expanded contributor guidance to use the maintainer-owned docs refactor skill when a section is too large, mixes tasks, or needs improved navigation/TOC support.
    • Added a complete end-to-end process for planning and executing documentation refactors, including topic ownership rules and a URL/anchor migration and redirect contract.
    • Introduced an additional constraint in the contributor update workflow to route structural/IA changes to the refactor skill when needed.
    • Updated the maintainer skills guide and counts to include the new refactor skill.

Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@miyoungc miyoungc added the area: docs Documentation, examples, guides, or docs build label Jul 13, 2026
@miyoungc miyoungc self-assigned this Jul 13, 2026
@miyoungc miyoungc added the area: docs Documentation, examples, guides, or docs build label 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

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: 9fa966d4-434b-4873-bca9-8b2d86678ab3

📥 Commits

Reviewing files that changed from the base of the PR and between 7678c10 and 8d532ac.

📒 Files selected for processing (1)
  • docs/CONTRIBUTING.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/CONTRIBUTING.md

📝 Walkthrough

Walkthrough

Adds a maintainer-owned NemoClaw documentation refactor skill, registers it in the skills catalog, and updates contributor guidance and release catch-up instructions to route structural documentation work through the new skill.

Changes

Documentation Refactor Workflow

Layer / File(s) Summary
Refactor planning and content design
.agents/skills/nemoclaw-maintainer-refactor-docs/SKILL.md
Defines prerequisites, documentation inventory, journey-based organization, navigation rules, and canonical ownership for refactored content.
Route migration and completion checks
.agents/skills/nemoclaw-maintainer-refactor-docs/SKILL.md
Specifies route and anchor migration, content-safe implementation order, validation audits, independent review, completion criteria, and result reporting.
Skill registration and contributor handoff
.agents/skills/nemoclaw-maintainer-refactor-docs/agents/openai.yaml, .agents/skills/nemoclaw-skills-guide/SKILL.md, docs/CONTRIBUTING.md, .agents/skills/nemoclaw-contributor-update-docs/SKILL.md
Registers the new agent interface, updates maintainer skill counts and listings, and directs contributors to use the refactor skill for oversized or structurally complex documentation changes.

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

Suggested labels: feature, area: skills

Suggested reviewers: cv, ericksoa

🚥 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 summarizes the main change: adding a maintainer docs refactor workflow.
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/maintainer-docs-refactor-skill

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

@github-code-quality

github-code-quality Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Code Coverage Overview

Languages: TypeScript

TypeScript / code-coverage/plugin

The overall coverage remains at 96%, unchanged from the main branch.

TypeScript / code-coverage/cli

The overall coverage in the codex/maintainer-doc... branch remains at 79%, unchanged from the main branch.

Show a code coverage summary of the most impacted files.
File main 73b35fc codex/maintainer-doc... 8d532ac +/-
src/lib/name-validation.ts 100% 94% -6%
src/lib/runner.ts 75% 72% -3%
src/lib/securit...ntial-filter.ts 99% 98% -1%
src/lib/state/gateway.ts 88% 90% +2%
src/lib/security/redact.ts 95% 99% +4%
src/lib/onboard...reachability.ts 63% 72% +9%

Updated July 13, 2026 18:29 UTC
Code Coverage is in Public Preview. Learn more and provide us with your feedback.

@github-actions

Copy link
Copy Markdown
Contributor

@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. This is a documentation and agent-skill guidance-only PR. It does not change installer or onboarding execution, sandbox lifecycle, credentials, security boundaries, network policy, inference routing, deployment configuration, or real assistant user flows. Docs validation is appropriate, but no existing E2E job is warranted.

Optional E2E

  • None.

New E2E recommendations

  • None.

@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 18:14

@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-refactor-docs/SKILL.md:
- Line 160: Update the documented Vitest command in SKILL.md to use the
repository-pinned binary, replacing npx vitest with npx --no-install vitest or
the existing npm script while preserving the same test files and run behavior.

In `@docs/CONTRIBUTING.md`:
- Around line 43-46: Revise the added guidance following the skill reference so
every sentence uses active, present-tense second-person wording. Update the
descriptions beginning with “It inventories” and “The skill lives” to address
the reader directly while preserving the existing skill path and documented
behavior.
🪄 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: 688a8538-6716-4e71-b8b8-140cf2d7ad17

📥 Commits

Reviewing files that changed from the base of the PR and between 7666b55 and 7678c10.

📒 Files selected for processing (5)
  • .agents/skills/nemoclaw-contributor-update-docs/SKILL.md
  • .agents/skills/nemoclaw-maintainer-refactor-docs/SKILL.md
  • .agents/skills/nemoclaw-maintainer-refactor-docs/agents/openai.yaml
  • .agents/skills/nemoclaw-skills-guide/SKILL.md
  • docs/CONTRIBUTING.md

Comment thread .agents/skills/nemoclaw-maintainer-refactor-docs/SKILL.md
Comment thread docs/CONTRIBUTING.md
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@miyoungc miyoungc added area: skills Skills, agent behaviors, prompts, or skill packaging v0.0.82 labels Jul 13, 2026
@miyoungc
miyoungc merged commit e62f7ab into main Jul 13, 2026
53 checks passed
@miyoungc
miyoungc deleted the codex/maintainer-docs-refactor-skill branch July 13, 2026 18:42
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: skills Skills, agent behaviors, prompts, or skill packaging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants