Skip to content

chore: add coderabbit instructions for docs#421

Merged
miyoungc merged 2 commits intomainfrom
docs/enhance-agent-review-for-docs
Mar 19, 2026
Merged

chore: add coderabbit instructions for docs#421
miyoungc merged 2 commits intomainfrom
docs/enhance-agent-review-for-docs

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented Mar 19, 2026

Summary by CodeRabbit

  • Chores
    • Added automated documentation review rules: strict editorial, formatting, terminology, and page-structure checks for docs content.
    • Added baseline Markdown checks across the repo to enforce casing standards and prohibit emoji in technical prose.

@miyoungc miyoungc self-assigned this Mar 19, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 3a9c7c74-b4a2-4db3-bf66-df6f7971b042

📥 Commits

Reviewing files that changed from the base of the PR and between 522b47e and e4f15d8.

📒 Files selected for processing (1)
  • .coderabbit.yaml

📝 Walkthrough

Walkthrough

Added two path-scoped review instruction sets to .coderabbit.yaml: one enforcing detailed editorial and structural rules for docs/** Markdown files, and one applying baseline casing and emoji rules to all other **/*.md files.

Changes

Cohort / File(s) Summary
Review configuration
\.coderabbit\.yaml
Added reviews.path_instructions[] with two entries: path: "docs/**" — extensive editorial, formatting, terminology, and page-structure checks; path: "**/*.md" — baseline Markdown checks (product/brand casing, NVIDIA casing, and emoji prohibition in technical prose).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hopped through rules both strict and kind,

Fixed tone, format, headings all aligned,
No emojis in code, titles neat and true,
Docs now whisper clarity — hooray, review! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding CodeRabbit instructions for documentation reviews in the .coderabbit.yaml configuration file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/enhance-agent-review-for-docs
📝 Coding Plan
  • Generate coding plan for human review comments

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

@miyoungc miyoungc added the documentation Improvements or additions to documentation label Mar 19, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.coderabbit.yaml:
- Around line 103-108: The glob pattern "**.md" is incorrect and the rule's
scope is ambiguous; update the rule that currently uses the glob "**.md" to the
recommended recursive glob "**/*.md" and revise the accompanying text to state
explicitly that this rule applies to all markdown files project-wide (and that
any stricter rules targeting docs/ defined earlier in the file will take
precedence). Locate the entry referencing "**.md" in the YAML and change the
pattern to "**/*.md", and update the instruction line that begins "For any
Markdown file outside docs/" to clarify scope and precedence with docs/.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 76313761-26be-4503-bbe2-06ba53cc0660

📥 Commits

Reviewing files that changed from the base of the PR and between 20a63d0 and 522b47e.

📒 Files selected for processing (1)
  • .coderabbit.yaml

Comment thread .coderabbit.yaml Outdated
Copy link
Copy Markdown
Contributor

@kjw3 kjw3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let it rip 🤙

@miyoungc miyoungc merged commit 6cca75e into main Mar 19, 2026
3 checks passed
Ryuketsukami pushed a commit to Ryuketsukami/NemoClaw that referenced this pull request Mar 24, 2026
* add coderabbit instructions for docs

* coderabbit suggestion
jessesanford pushed a commit to jessesanford/NemoClaw that referenced this pull request Mar 24, 2026
* add coderabbit instructions for docs

* coderabbit suggestion
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants