docs: add scoped AGENTS guidance - #5368
Conversation
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
|
🌿 Preview your docs: https://nvidia-preview-pr-5368.docs.buildwithfern.com/nemoclaw |
|
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 (1)
📝 WalkthroughWalkthroughUpdates documentation guidance: makes ChangesAgent Documentation Guidelines
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorFailed: Could not parse JSON from advisor output; see /home/runner/work/NemoClaw/NemoClaw/artifacts/e2e-advisor/e2e-advisor-raw-output.txt |
Vitest E2E Scenario RecommendationRequired Vitest E2E scenarios: None Full Vitest E2E advisor summaryVitest E2E Scenario AdvisorFailed: Could not parse JSON from advisor output; see /home/runner/work/NemoClaw/NemoClaw/artifacts/e2e-advisor/e2e-scenario-advisor-raw-output.txt |
PR Review AdvisorFindings: 0 needs attention, 0 worth checking, 0 nice ideas This is an automated advisory review. A human maintainer must make the final merge decision. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
AGENTS.md (1)
191-191: 📐 Maintainability & Code Quality | ⚡ Quick winName the concrete doc-writer skill.
docs/CONTRIBUTING.mdalready points atnemoclaw-contributor-update-docs, so using that name here makes the handoff step unambiguous.As per coding guidelines,
docs/CONTRIBUTING.mdalready namesnemoclaw-contributor-update-docs.🤖 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 191, Update the doc-writer step text to reference the concrete skill name "nemoclaw-contributor-update-docs" instead of the generic "documentation writer subagent"; change the sentence in AGENTS.md describing the handoff so it instructs running the named skill with the changed files, behavior summary, and test evidence (matching docs/CONTRIBUTING.md) to avoid ambiguity.
🤖 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 32: Update the guidance so it aligns with the CONTRIBUTING rule: state
that pages should not duplicate the title as a body H1 because Fern renders the
title from frontmatter (reference: title.page), but make an explicit exception
callout that the CONTRIBUTING document must include an H1 that matches
title.page; ensure the sentence in AGENTS.md mentions both "H1" and "title.page"
and the exception for the CONTRIBUTING doc to avoid confusion.
---
Nitpick comments:
In `@AGENTS.md`:
- Line 191: Update the doc-writer step text to reference the concrete skill name
"nemoclaw-contributor-update-docs" instead of the generic "documentation writer
subagent"; change the sentence in AGENTS.md describing the handoff so it
instructs running the named skill with the changed files, behavior summary, and
test evidence (matching docs/CONTRIBUTING.md) to avoid ambiguity.
🪄 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: 272be642-7fd3-4b96-a90d-6903a397fb6f
📒 Files selected for processing (3)
AGENTS.mddocs/AGENTS.mdfern/AGENTS.md
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
wscurran
added
area: ci
3 participants
Summary
Adds scoped AGENTS.md guidance for the docs and Fern areas, and clarifies the root documentation workflow for implementation agents.
This makes the documentation engineer role explicit and asks development agents to hand off to a documentation writer subagent before final handoff.
This also fixes the PR docs-only check by using the pull request base SHA instead of
HEAD^1, which is unavailable in the shallow checkout.Related Issue
N/A.
Changes
docs/AGENTS.mdwith documentation engineer and writer guidance for source docs.fern/AGENTS.mdwith Fern site configuration guidance.AGENTS.mddocumentation section and added the post-development docs writer subagent handoff rule.docs-only-checksto fetch${{ github.event.pull_request.base.sha }}for diff-scopedprekhooks instead of readingHEAD^1from a depth-1 checkout.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Verification notes:
npm run docspassed. Fern reported one existing upgrade-availability warning, so the no-warnings checkbox is left unchecked.npx prek run --files .github/workflows/pr.yamlpassed.npx prek run --all-filesfailed in unrelated CLI test lanes: Docker Desktop WSL GPU patch expectations, shell probe signal expectation, and e2e scenario workflow bash compatibility.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
Documentation
Chores