docs: centralize documentation guidance - #8166
Conversation
|
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. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe change reorganizes documentation guidance around ChangesDocumentation governance
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant DocumentationTask
participant DocsAgents
participant DORI
participant DocsContributorGuide
DocumentationTask->>DocsAgents: Read routing and workflow rules
DocsAgents->>DORI: Detect host capabilities and apply fallback rules
DORI->>DocsContributorGuide: Route public documentation work
DocsAgents->>DocsContributorGuide: Apply procedures and verification
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-pr-8166.docs.buildwithfern.com/nemoclaw |
PR Review Advisor — No blocking findings reportedAdvisor assessment: No blocking advisor findings reported Model lanes
Second-opinion terminology and E2E selections are advisory. They do not change the primary assessment or E2E / PR Gate. 1 semantic terminology decisionTerminology decisions are advisory. They affect the assessment only when a separate finding identifies concrete semantic impact.
E2E guidanceAdvisory only. E2E / PR Gate selects and runs jobs independently. Recommended E2E: None This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge. |
Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>
|
Resolved the repository contract failure in the documentation-routing refactor.
This remains a documentation-governance change with no sensitive runtime path changes. The PR remains a draft; I did not change its review routing or readiness state. |
|
Follow-up: the transient advisor retry passed. All current required checks are green, all review threads are resolved, and approval is recorded. The PR remains a draft, so the author-controlled readiness decision is the only remaining merge gate; I have not changed that state. |
|
Merge-train status: all current checks pass and approval is present. The only remaining gate is the draft state, which requires the contributor to confirm the PR is ready for merge. I will re-audit and merge normally once it is marked ready. |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in commit 6aae132 in the TypeScript / code-coverage/cliThe overall coverage in commit 6aae132 in the Updated |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
AGENTS.md (1)
24-24: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winLoad the shared documentation contract in
nemoclaw-contributor-onboard-messaging-channel.This skill reviews and updates user-facing documentation but does not load
.agents/skills/_shared/documentation-writing-review.md,WRITING.md, ordocs/CONTRIBUTING.md. Add explicit routing before removing the global requirement.🤖 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.md` at line 24, Update the nemoclaw-contributor-onboard-messaging-channel skill instructions to explicitly load and follow .agents/skills/_shared/documentation-writing-review.md, WRITING.md, and docs/CONTRIBUTING.md before removing or relaxing the global documentation requirement.
🤖 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 `@docs/AGENTS.md`:
- Line 60: Update the guidance around
`.agents/skills/nemoclaw-user-guide/SKILL.md` to identify it as an autogenerated
output from `docs/`; instruct maintainers to edit the relevant `docs/` source
and regenerate the skill rather than modifying the generated file directly.
---
Outside diff comments:
In `@AGENTS.md`:
- Line 24: Update the nemoclaw-contributor-onboard-messaging-channel skill
instructions to explicitly load and follow
.agents/skills/_shared/documentation-writing-review.md, WRITING.md, and
docs/CONTRIBUTING.md before removing or relaxing the global documentation
requirement.
🪄 Autofix
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: a343d1ed-feb1-45df-8b09-39716c26cfc8
📒 Files selected for processing (13)
.agents/skills/_shared/controlled-words.md.agents/skills/_shared/documentation-writing-review.md.agents/skills/nemoclaw-contributor-create-pr/SKILL.md.agents/skills/nemoclaw-maintainer-refactor-docs/SKILL.mdAGENTS.mdCONTRIBUTING.mdWRITING.mddocs/AGENTS.mddocs/CONTRIBUTING.mddocs/DORI_SETUP.mddocs/resources/engineer-agentic-documentation.mdxtest/maintainer-skills-policy.test.tstest/skills-frontmatter.test.ts
Summary
Simplifies documentation governance into a one-way authority flow with one owner for each concern. DORI routing now lives in
docs/AGENTS.md, and explicit topology checks prevent guidance links from recreating cycles.Changes
docs/AGENTS.md, documentation procedures todocs/CONTRIBUTING.md, writing rules toWRITING.md, and terminology to the controlled word list.docs/AGENTS.md; keepdocs/DORI_SETUP.mdlimited to explicit installation and configuration requests.WRITING.mdand add tests for the resulting acyclic authority graph.Type of Change
Quality Gates
Documentation Writer Review
docs-updated.agents/skills/_shared/controlled-words.md,.agents/skills/_shared/documentation-writing-review.md,.agents/skills/nemoclaw-contributor-create-pr/SKILL.md,.agents/skills/nemoclaw-maintainer-refactor-docs/SKILL.md,AGENTS.md,CONTRIBUTING.md,WRITING.md,docs/AGENTS.md,docs/CONTRIBUTING.md,docs/DORI_SETUP.md,docs/resources/engineer-agentic-documentation.mdx, and the topology assertions intest/maintainer-skills-policy.test.tsandtest/skills-frontmatter.test.ts. The initial review found no findings after the return link from the controlled word list was removed and confirmed that DORI routing is owned bydocs/AGENTS.md. After the requested reverts, an independent Codex Desktop documentation writer re-reviewedAGENTS.mdandCONTRIBUTING.md, found no findings, confirmed that the restored links remain one-way, and reviewed the writing rules and documentation style.npm run docspassed with 0 errors and 1 existing warning; the targeted skills, policy, route, and link tests passed; normal hooks passed; andgit diff --checkpassed.DGX Station Hardware Evidence
Verification
Signed-off-by:line and every commit appears asVerifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passed, ornpm run validate:prpassed after refreshingorigin/mainwhen hooks were skipped or unavailabletest/skills-frontmatter.test.tspassed 30 of 30 tests; the targeted documentation-authority policy tests passed 2 of 2; and the route and link suites passed 45 of 45.npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — command/result:npm run docsbuilds without warnings (doc changes only) — Result: passed with 0 errors and 1 existing warning.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
Documentation
Tests