Skip to content

Conversation

@afritzler
Copy link
Member

@afritzler afritzler commented Feb 10, 2026

Summary by CodeRabbit

  • Documentation
    • Added a new Community section with a welcome page, contributing guide, and style guides for code and docs
    • Removed older contributing and documentation style-guide pages
    • Updated site navigation to include a top-level Community link and adjusted the Overview link/path configuration

@afritzler afritzler requested a review from a team as a code owner February 10, 2026 19:55
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 10, 2026

Warning

Rate limit exceeded

@afritzler has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 20 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

Walkthrough

This 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

Cohort / File(s) Summary
VitePress Navigation
docs/.vitepress/config.mts
Updated themeConfig.nav (added Community -> /community/, changed Overview to /overview/) and extended themeConfig.sidebar with a /community/ section (Community and Style Guide groups).
New Community Content
docs/community/index.md, docs/community/contributing.md
Added community landing page and a comprehensive contributing guide (prereqs, workflow, PR process, local checks, reporting).
New Community Style Guides
docs/community/style-guide/coding.md, docs/community/style-guide/documentation.md
Added coding style guide (Go conventions, testing, linting, commits) and documentation style guide (tone, content types, formatting, naming, code blocks, diagrams).
Removed Legacy Docs
docs/contribute/contributing.md, docs/contribute/style-guide.md
Deleted legacy contributing and documentation style-guide files; content migrated into the new /docs/community/ structure.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is missing entirely; the required 'Proposed Changes' section and other template elements are not present. Add a pull request description following the template with 'Proposed Changes' bullet points, issue references (Fixes #), and clear summary of the changes being made.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add community section' directly reflects the main change—adding a new community section to the documentation with navigation, contributing guide, and style guides.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-community-section

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.

❤️ Share

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

Copy link
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

🤖 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.

@afritzler afritzler force-pushed the add-community-section branch from 62abf15 to 92d91de Compare February 10, 2026 19:59
@afritzler afritzler added the enhancement New feature or request label Feb 10, 2026
Copy link
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

🤖 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.

Comment on lines 58 to 64
## 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

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.

@afritzler afritzler force-pushed the add-community-section branch from 92d91de to b0feca6 Compare February 10, 2026 20:04
@afritzler afritzler merged commit 37fa7ed into main Feb 10, 2026
6 checks passed
@afritzler afritzler deleted the add-community-section branch February 10, 2026 20:05
@hardikdr hardikdr added this to Roadmap Feb 11, 2026
@github-project-automation github-project-automation bot moved this to Done in Roadmap Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request size/XXL

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant