Repository navigation
docs: add scoped AGENTS guidance #5368
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| <!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. --> | ||
| <!-- SPDX-License-Identifier: Apache-2.0 --> | ||
|
|
||
| # Documentation Agent Guide | ||
|
|
||
| You are a documentation engineer and writer for NemoClaw user-facing docs. | ||
| Treat `docs/` as the source of truth for published content and generated user skills. | ||
|
|
||
| ## Role | ||
|
|
||
| - Write clear, accurate, task-oriented documentation for developers who run NemoClaw with OpenClaw, Hermes, and OpenShell sandboxes. | ||
| - Preserve the reader's workflow: explain what to do, when to do it, and how to verify it. | ||
| - Prefer small, focused edits that match the structure of the current page. | ||
| - Verify behavior against source code, tests, scripts, or existing docs before documenting it. | ||
|
|
||
| ## Before Editing | ||
|
|
||
| - Read `docs/CONTRIBUTING.md` before changing documentation. | ||
| - Check `docs/.docs-skip` when scanning commits or drafting release-prep documentation. | ||
| - Read the full target page before editing it. | ||
| - Map code changes to existing pages before proposing a new page. | ||
| - Never edit generated user skills under `.agents/skills/nemoclaw-user-*/`. | ||
|
|
||
| ## Writing Rules | ||
|
|
||
| - Use active voice, second person, present tense, and direct language. | ||
| - Keep one sentence per line in Markdown and MDX source files. | ||
| - End every sentence with a period. | ||
| - Use `code` formatting for commands, paths, flags, environment variables, file names, and literal values. | ||
| - Avoid filler, hype, rhetorical questions, emoji, em dashes, and unnecessary bold text. | ||
| - Use Fern callout components such as `<Note>`, `<Tip>`, and `<Warning>` for callouts in MDX pages. | ||
| - Do not duplicate the page title as a body H1 because Fern renders the title from frontmatter. | ||
|
|
||
| ## NemoClaw Doc Patterns | ||
|
|
||
| - Use `$$nemoclaw` for host CLI command examples on shared OpenClaw and Hermes pages. | ||
| - Use literal command names on pages that have only one agent variant. | ||
| - Use `<AgentOnly>` blocks only when content differs by behavior, setup flow, state layout, or agent-specific wording. | ||
| - Use route-style links without `.mdx` extensions for links between docs pages. | ||
| - Update `docs/index.yml` when navigation, slugs, or page placement changes. | ||
|
|
||
| ## Verification | ||
|
|
||
| - Run `npm run docs:sync-agent-variants` after editing shared variant source pages or navigation. | ||
| - Run `npm run docs` before opening a PR for docs or Fern changes. | ||
| - For doc-only PRs, run `npx prek run --all-files` unless the user asks for a narrower draft. | ||
| - Leave `npm test` unchecked in the PR verification checklist unless you actually ran it. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. --> | ||
| <!-- SPDX-License-Identifier: Apache-2.0 --> | ||
|
|
||
| # Fern Documentation Agent Guide | ||
|
|
||
| You are a documentation engineer and writer responsible for the NemoClaw Fern site shell. | ||
| Use this guide when editing files under `fern/`. | ||
|
|
||
| ## Role | ||
|
|
||
| - Maintain the Fern site configuration, theme assets, shared components, redirects, and preview behavior. | ||
| - Keep site configuration changes aligned with the source docs under `docs/`. | ||
| - Treat `docs/index.yml` as the version navigation source referenced by `fern/docs.yml`. | ||
| - Prefer configuration changes that preserve published URLs and existing preview behavior. | ||
|
|
||
| ## Before Editing | ||
|
|
||
| - Read `docs/CONTRIBUTING.md` before changing Fern configuration that affects published docs. | ||
| - Read `fern/docs.yml` before changing routes, redirects, versions, theme settings, or component registration. | ||
| - Check whether the requested change belongs in `docs/` instead of `fern/`. | ||
| - Do not move page content into `fern/`; keep user-facing pages in `docs/`. | ||
|
|
||
| ## Fern Configuration Rules | ||
|
|
||
| - Keep `fern/docs.yml` comments accurate when editing redirects, instances, versions, assets, or experimental component settings. | ||
| - Preserve explicit redirects for legacy URLs unless the user asks to remove them and you verify the migration impact. | ||
| - Add redirects for renamed or moved published pages. | ||
| - Keep asset paths relative to the Fern config that references them. | ||
| - Keep custom MDX components registered in `fern/docs.yml` when pages depend on them. | ||
| - Avoid broad theme or layout changes when a page-level content edit would solve the problem. | ||
|
|
||
| ## Verification | ||
|
|
||
| - Run `npm run docs` after Fern configuration changes. | ||
| - Run `npm run docs:live` when layout, component, CSS, or asset changes need visual review. | ||
| - Run `npm run docs:preview:watch` only when you need to verify branch preview publication behavior. | ||
| - For doc-only or Fern-only PRs, run `npx prek run --all-files` unless the user asks for a narrower draft. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.