Skip to content
cccskills
FreePublished on GitHub

nemoclaw-maintainer-refactor-docs

Reorganize NemoClaw documentation into focused pages with clearer navigation and a single home for each topic. Plan or implement structural changes while preserving useful information and existing published URLs, then validate routes, links, and builds.

OriginalShow the original description

Reorganize NemoClaw documentation pages, navigation, or content ownership while preserving published routes. Use for structural documentation refactors.

See how to install

Good for

  • Splitting long documentation pages into focused topics
  • Consolidating duplicated troubleshooting and reference content
  • Reorganizing navigation while preserving published URLs
  • Preparing a documentation structure and migration plan

Files included (5)

  • SKILL.md4.3 KB
  • agents/openai.yaml442 B
  • references/migration.md4.5 KB
  • references/structure.md4.5 KB
  • references/validation.md2.3 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. SPDX-License-Identifier: Apache-2.0 -->

Refactor NemoClaw Documentation

Refactor a bounded documentation section without changing product meaning. Improve findability while preserving every useful fact, one canonical owner per topic, and every supported published route.

Prerequisites

  • Work from the NemoClaw repository root.
  • Follow the shared Documentation Writing and Review contract before planning or editing.
  • Read the full target pages, their navigation entries in docs/index.yml, their redirects in fern/docs.yml, and their inbound links before editing.

Choose the Deliverable

  • Treat cross-section ownership, navigation hierarchy, and published URL changes as maintainer-owned decisions.
  • For a request to plan, audit, or propose a structure, stop after the information architecture, ownership map, and URL migration plan.
  • For a request to refactor, implement the plan, validate it, and report the completed migration.
  • Keep the work bounded to the named docs section. Report adjacent debt instead of folding unrelated cleanup into the refactor.
  • Allow a cross-section move when canonical ownership requires it, but identify the move explicitly in the plan and migration report.
  • Surface a choice only when it changes topic ownership, public URLs, supported variants, or user workflow. Use established repository conventions for routine details.

Load the phase that applies

  • For an audit or structure plan, use Structure and Ownership.
  • Before changing published routes or moving content, use Migration. A plan that changes URLs must include its route and anchor mapping.
  • For an implemented refactor, use Validation and Review. Repair findings and rerun affected checks before reporting completion.

Do not load execution-only detail for a plan-only request. A request to perform the refactor includes implementation and validation; it does not require a separate approval of routine layout choices within the accepted scope.

Completion Contract

For a plan-only request, completion means the ownership map, proposed structure, route migration plan, and unresolved decisions are recorded. The implementation checks and validation results below apply only when the refactor was performed.

For an implemented refactor, require all of these conditions:

  • Every visible TOC item that readers can select is a real topic page.
  • Every foldable grouping node is non-clickable and has no page content.
  • Each page owns one primary topic or task.
  • Every old section is mapped to a destination or intentionally removed with a stated reason.
  • Troubleshooting and reference guidance has one canonical owner.
  • No supported variant renders a link or redirect to an unpublished page.
  • Legacy URLs redirect directly to final published pages.
  • Shared content renders correctly for every applicable agent variant.
  • Source and generated variant pages have no unresolved oversized or multi-purpose prose blocks.
  • Simple lists remain compact.
  • The docs build, route checks, link checks, and diff check pass.

Report the Result

For a plan-only request, report the proposed structure, ownership, routes, and remaining decisions. For an implemented refactor, summarize:

  • The final journey-based TOC.
  • Pages created, moved, consolidated, and deleted.
  • Canonical troubleshooting and reference ownership decisions.
  • Redirects and legacy routes preserved.
  • Variant-specific differences.
  • Readability edits made to dense paragraph blocks.
  • Validation commands and results.
  • Any intentionally deferred adjacent cleanup.

Use the Inference section as the living example of this method when a concrete pattern is needed. Its structure separates About Inference Routing, choosing a provider and model, hosted/local/custom setup paths, management, validation, and canonical Reference troubleshooting. Copy the reasoning and consistency rules, not the inference-specific page names.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Publish or update a NemoClaw pull request and track automated checks and reviews through completion. It preserves the requested scope, coordinates repairs for valid findings, and reports the latest commit’s results and remaining blockers.

  • Publishing implemented changes as a pull request
  • Updating an open pull request after review feedback
  • Tracking automated checks and reviews on the latest commit
NVIDIA/NemoClaw22.8KUpdated Oct 21, 2026

Implement an accepted NemoClaw issue or repair a classified pull request finding. Keep changes within the agreed scope, run focused checks for affected behavior, and review the final changes before handing evidence to an authorized publication workflow.

  • Implement an accepted issue within its agreed scope
  • Repair a classified pull request finding
  • Validate failure, recovery, and cleanup behavior
NVIDIA/NemoClaw22.8KUpdated Oct 21, 2026

Prepare a local NemoClaw development environment, repair setup problems, or check readiness. It also handles explicitly requested command-line access, runtime onboarding, and launching the coding agent pinned by the project.

  • Setting up a local NemoClaw development environment
  • Checking readiness before starting development
  • Repairing local dependency, build, or hook problems
NVIDIA/NemoClaw22.8KUpdated Oct 21, 2026

Turn a named NemoClaw issue into an implementation plan with clear ownership, scope, completion criteria, and validation evidence. For larger changes, define independently useful steps, their dependencies, and delivery order.

  • Plan implementation for a named issue
  • Divide a large change into useful steps
  • Define acceptance criteria and test evidence
NVIDIA/NemoClaw22.8KUpdated Oct 21, 2026

Audit and upgrade NemoClaw dependencies, including Hermes and base images. Trace upstream changes to affected code, implement required migrations, and verify tests, distributed artifacts, and the versions actually selected for use.

  • Assess the impact of a dependency upgrade
  • Plan migrations for a Hermes upgrade
  • Verify base images and selected artifacts
NVIDIA/NemoClaw22.8KUpdated Oct 21, 2026

Update NemoClaw documentation after merged changes or audit it for outdated guidance. Verify current behavior against source and tests, edit the pages responsible for that guidance, and check affected links and generated variants.

  • Catch up documentation after merged changes
  • Audit documentation for outdated guidance
  • Update guides for changed user behavior
NVIDIA/NemoClaw22.8KUpdated Oct 21, 2026

See all skills by NVIDIA

Report a problem with this skill