Need a page about Suguested Reviewers

[alexcoderabbitai]

A customer said our Suguested Reviewers is better than githubs but we should have a page on how this works.

Here’s a concise summary of how the system selects reviewers:
• Matches reviewers based on alignment with PR titles, AI-generated summaries, and objectives to ensure relevance to the code changes.
• Considers reviewers who have previously modified the same files.
• Prioritizes reviewers familiar with the same functions, classes, or variables being altered.

[linear]

ENG-1527 Need a page about `Suguested Reviewers`

[traycerai]

Plan

Observations

• We need to add a new Suggested Reviewers documentation page under docs/guides, following the existing PR review guides conventions.
• The page must explain three core matching strategies: Relevance Matching, File History Analysis, and Code Construct Familiarity.
• The sidebar (sidebars.ts) under the “Review pull requests” category must include a reference to this new page.

Approach

• Create docs/guides/suggested-reviewers.md with YAML frontmatter and structured sections matching existing guides.
• Populate content with brief introduction, detailed “How It Works” subsections, benefits, and a “See Also” section linking to related guides.
• Modify sidebars.ts to insert "guides/suggested-reviewers" after the code review overview entry.
• Build and verify that the new page appears correctly in navigation and links resolve without errors.

Reasoning

• Reviewed existing PR review documentation files to understand naming, frontmatter, content patterns, and directory layout.
• Examined sidebars.ts and docusaurus.config.ts to identify where and how to integrate a new guide into the sidebar.
• Confirmed file paths, reference formats, and ordering conventions.

Proposed File Changes

📄 docs/guides/suggested-reviewers.md ^(NEW) 🔗

References

• 📄 docs/guides/code-review-overview.md
• 📄 docs/guides/review-instructions.md

1. Create a new Markdown file at docs/guides/suggested-reviewers.md.
2. Add YAML frontmatter at the top:

   ---
   title: Suggested Reviewers
   description: Learn how CodeRabbit's intelligent reviewer suggestion system selects the most relevant reviewers for your pull requests.
   ---

3. Draft the following sections using Markdown headings:
   • ## What Are Suggested Reviewers?
     Briefly introduce the feature and its value.
   • ## How It Works
     • ### Relevance Matching
       • Explain matching based on PR title, AI-generated summary, and objectives.
     • ### File History Analysis
       • Describe how reviewers who previously modified the same files are selected.
     • ### Code Construct Familiarity
       • Highlight prioritization of reviewers familiar with the functions, classes, or variables being changed.
   • ## Benefits
     List advantages such as faster reviews, more accurate feedback, and reduced unnecessary pings.
   • ## See Also
     • Link to docs/guides/code-review-overview.md
     • Link to docs/guides/review-instructions.md
4. Use Docusaurus callouts (e.g., :::tip, :::note) for key information and bullet lists for clarity.

📄 sidebars.ts ^(MODIFY) 🔗

1. Open sidebars.ts and locate the Review pull requests category’s items array.
2. Insert the new entry after "guides/code-review-overview":

   items: [
     "guides/code-review-overview",
     "guides/suggested-reviewers",
     "guides/commands",
     // ... other existing items
   ]

3. Save and rebuild to ensure the new item appears in the sidebar.

Import In IDE

Developer Humor

A new doc page spun into view,
Suggested Reviewers, shiny and new!
No more guess who’s next to review,
Our sidebar now shows it too.
Build the site—give it a view! 🚀

---

Execution Information

Branch: main
Commit: 002a4b4

---

💡 Tips

Supported Commands (Inside Comments)

• Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

• Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
• Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.