Add examples to the code review overview

[jmacdotorg]

The code review overview page should have a short list of links to real pull requests showing examples of CodeRabbit in action.

Alternatively, we could link to a saved search of some kind instead of a curated list?

[linear]

ENG-1494 Add examples to the code review overview

[traycerai]

Plan

Observations

• The code review overview page (docs/guides/review-instructions.md) thoroughly documents custom review instructions but omits real-world examples demonstrating CodeRabbit in action.
• Other parts of the docs use raw GitHub PR URLs and a saved search link format for live examples.
• Plugin analysis confirmed that manually inserting markdown is the simplest, most maintainable approach, requiring no new dependencies.

Approach

1. Open docs/guides/review-instructions.md and locate the end of the “AST-based instructions” section (around line 111).
2. Insert a new ## Real-World Examples section using the same styling conventions (## for headings, - for bullets, Markdown links, em dashes for descriptions).
3. Include three curated PR links showcasing different CodeRabbit capabilities, plus a saved search URL for broader discovery.
4. Run the docs build locally to verify formatting and link accuracy.
5. Commit, push, and open a PR for review.

Reasoning

• Audited documentation files to pinpoint the correct overview page and insertion point.
• Reviewed styling conventions in existing markdown sections.
• Gathered representative PR examples and a GitHub search URL from other docs and repo patterns.
• Evaluated plugin options and decided on manual markdown addition for simplicity.

Proposed File Changes

📄 docs/guides/review-instructions.md ^(MODIFY) 🔗

Open docs/guides/review-instructions.md, locate the end of the “AST-based instructions” section (around line 111), and insert the following snippet, ensuring blank lines before and after to match existing formatting:

## Real-World Examples

See CodeRabbit in action with these examples from real pull requests:

- [Appsmith PR #38270](https://github.com/appsmithorg/appsmith/pull/38270) — CodeRabbit review demonstrating comprehensive code analysis
- [DevTools Academy PR #44](https://github.com/tyaga001/devtoolsacademy/pull/44) — Shows CodeRabbit’s adaptive learning and performance optimization suggestions  
- [OpenReplay PR #1858](https://github.com/openreplay/openreplay/pull/1858) — Example of CodeRabbit’s context-aware review capabilities

Browse all CodeRabbit reviews: [GitHub Search Results](https://github.com/search?q=coderabbitai&type=pullrequests)

Import In IDE

Developer Humor

Code review now gets a cheer,
With live PRs to make it clear.
Links to show what Rabbit sees,
Because examples are the keys!
Docs go live—maintenance with ease! 🚀

---

Execution Information

Branch: main
Commit: e2e3084

---

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