feat: add Coderabbit config for community documentation - #3552
feat: add Coderabbit config for community documentation#3552bandantonio wants to merge 1 commit into
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis pull request introduces a new ChangesCodeRabbit Documentation Guidelines Configuration
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 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)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![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)
.coderabbit.yaml (1)
18-18: ⚡ Quick winResolve or remove TODO from active review instructions.
Line 18 embeds an unfinished rule in production guidance. Either convert it into a concrete rule now or remove it until finalized to avoid ambiguous reviewer behavior.
If you want, I can draft a concrete README-link policy line that fits the style of the existing bullets.
🤖 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 @.coderabbit.yaml at line 18, Replace the dangling TODO "TODO: add a rule on how links to/from README.md should be handled as they are not rendered on the website." in the active review guidance with a concrete rule or remove it entirely; specifically update the .coderabbit configuration entry that contains that TODO by either (a) adding a one-line policy such as "Links to/from README.md should be maintained in the repo but not relied upon for site navigation; include cross-references in docs/ for rendered site links" or (b) deleting the TODO line so no unfinished instruction appears in production guidance.
🤖 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 @.coderabbit.yaml:
- Line 13: The example list for secondary bucket prefixes is malformed—fix the
punctuation around the examples in the sentence that begins "The numeric prefix
of secondary content buckets..." so each example uses consistent backticks and
commas (e.g., replace the incorrect fragment `011-', '012-'` with `011-`,
`012-`), ensuring examples match the primary examples (`000-`, `010-`, `020-`)
and use consistent quoting/backticks throughout the rule.
---
Nitpick comments:
In @.coderabbit.yaml:
- Line 18: Replace the dangling TODO "TODO: add a rule on how links to/from
README.md should be handled as they are not rendered on the website." in the
active review guidance with a concrete rule or remove it entirely; specifically
update the .coderabbit configuration entry that contains that TODO by either (a)
adding a one-line policy such as "Links to/from README.md should be maintained
in the repo but not relied upon for site navigation; include cross-references in
docs/ for rendered site links" or (b) deleting the TODO line so no unfinished
instruction appears in production guidance.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
There was a problem hiding this comment.
Pull request overview
Adds a CodeRabbit configuration file with path-specific review instructions intended to guide AI-assisted reviews/edits of the repo’s community documentation after the docs reorganization (#1833).
Changes:
- Introduces
.coderabbit.yamlwith English locale andreviews.path_instructionstargetingdocs/**. - Documents rules for section metadata (
_section.md/index.md), folder naming/weights, and link format expectations for community docs.
Comments suppressed due to low confidence (1)
.coderabbit.yaml:14
- The guidance around secondary content buckets conflicts with the next bullet: line 13 describes secondary buckets as “subfolders within primary content buckets”, but line 14 states the website doesn't support nested folders beyond the first level under
docs. Please clarify whether “secondary” buckets are meant to be sibling folders (e.g.,011-*next to010-*) or actual nested subfolders, and align these bullets accordingly.
- The numeric prefix of primary content buckets is assigned in increments of 10 (e.g., `000-`, `010-`, `020-`, etc.). The numeric prefix of secondary content buckets (subfolders within primary content buckets) is assigned in increments of 1 to the content bucket they belong to (e.g., `011-', '012-', or '021-', '022-', etc.).
- No nested folders exist beyond the content bucket folders. The current website's implementation doesn't support nested folders, so all content must be organized within the first level of folders under `docs`.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ee3f8fd to
3b3a0ae
Compare
|
3b3a0ae to
ca2583b
Compare
|
Description
This PR adds path instructions to CodeRabbit configuration to make AI assistant aware of the community documentation and help fixing the rest of the inconsistencies that appeared after the global refactoring of the community documentation (#1833)
Related issue(s)
Summary by CodeRabbit