-
Notifications
You must be signed in to change notification settings - Fork 3
Add community section #114
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
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThis PR moves contributor and style-guide content from /docs/contribute/ into a new /docs/community/ hierarchy, adds new community pages, removes the old contribute files, and updates VitePress navigation/sidebar to include a top-level "Community" link and related sidebar entries. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 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 |
There was a problem hiding this 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
🤖 Fix all issues with AI agents
In `@docs/community/index.md`:
- Around line 23-25: The markdown link currently pointing to
"/community/style-guide" is broken; update the link target so it resolves to the
existing pages — replace the dead "/community/style-guide" URL with links to the
split pages (for example "/community/style-guide/coding" and
"/community/style-guide/documentation"), or change it to a combined reference
that lists both; ensure the link text still reads "Coding & Docs Conventions"
and update any surrounding punctuation so the two valid URLs are included in the
sentence.
🧹 Nitpick comments (1)
docs/community/index.md (1)
1-30: Page is missing YAML front matter and has no explicit title metadata.This is minor, but other VitePress pages typically benefit from front matter (e.g.,
title,description) for SEO and consistent sidebar rendering. Consider adding it if the rest of the docs follow that pattern.
62abf15 to
92d91de
Compare
There was a problem hiding this 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
🤖 Fix all issues with AI agents
In `@docs/community/style-guide/documentation.md`:
- Around line 58-64: The document's headings violate its own rule: change all
H2+ headings in this file (e.g., the "## Headings" section and every "## ..."
and "### ..." instance) from title case to sentence case so only the first word
is capitalized; update each heading text accordingly, keep anchor-uniqueness, do
not renumber or reorder sections, and ensure the "## Headings" examples and any
headings referenced in that section reflect the corrected sentence-case style.
🧹 Nitpick comments (1)
docs/community/style-guide/documentation.md (1)
66-70: Consider reducing repetitive sentence beginnings.Three consecutive bullet points start with "Use", which slightly impacts readability.
♻️ Optional refactor for variety
## Lists -- Use `1.` for every numbered list item — the renderer handles numbering. -- Use `-` for bulleted lists. -- Use 4-space indentation for nested items. +- Use `1.` for every numbered list item — the renderer handles numbering. +- Use `-` for bulleted lists. +- Indent nested items with 4 spaces.
| ## Headings | ||
|
|
||
| - One `#` (H1) per page as the document title. | ||
| - Use `##` and below for sections. Do not skip heading levels. | ||
| - Use **sentence case**: capitalize the first word only. | ||
| - Keep headings unique within a document — they generate anchor links. | ||
| - Do not number headings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The document violates its own sentence case rule.
Line 62 prescribes sentence case for headings ("capitalize the first word only"), but many H2 headings in this document use title case instead. This creates confusion about which convention to follow.
📝 Proposed fix to align headings with sentence case rule
-## Language and Tone
+## Language and tone
-## Content Types
+## Content types
-## API Object Names
+## API object names
-## Inline Code
+## Inline code
-## Code Blocks
+## Code blocks
-## Images and Screenshots
+## Images and screenshots
-## File and Folder Naming
+## File and folder naming🤖 Prompt for AI Agents
In `@docs/community/style-guide/documentation.md` around lines 58 - 64, The
document's headings violate its own rule: change all H2+ headings in this file
(e.g., the "## Headings" section and every "## ..." and "### ..." instance) from
title case to sentence case so only the first word is capitalized; update each
heading text accordingly, keep anchor-uniqueness, do not renumber or reorder
sections, and ensure the "## Headings" examples and any headings referenced in
that section reflect the corrected sentence-case style.
92d91de to
b0feca6
Compare
Summary by CodeRabbit