Skip to content

Add an "anatomy of a review" doc? #358

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

Open
jmacdotorg opened this issue May 23, 2025 · 1 comment
Open

Add an "anatomy of a review" doc? #358

jmacdotorg opened this issue May 23, 2025 · 1 comment
Labels
needs triage A new docs bug that needs to be processed and planned by the docs project owners

Comments

@jmacdotorg
Copy link
Collaborator

CodeRabbit's comments can be long, rich, and complex, with many sections. Some of the sections are collapsed, and it's not always clear by name alone what they do. It's also not always clear why CodeRabbit sometimes includes certain sections, or not.

We should document all the sections that might appear in a code review, the conditions under which CodeRabbit makes them, how CodeRabbit generates them, and what they all mean. That would do a lot to increase the transparency of this toolkit!

@jmacdotorg jmacdotorg added the needs triage A new docs bug that needs to be processed and planned by the docs project owners label May 23, 2025
Copy link

linear bot commented May 23, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage A new docs bug that needs to be processed and planned by the docs project owners
Projects
None yet
Development

No branches or pull requests

1 participant