Skip to content

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

Open
@jmacdotorg

Description

@jmacdotorg
Contributor

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!

Activity

added
needs triageA new docs bug that needs to be processed and planned by the docs project owners
on May 23, 2025
removed
needs triageA new docs bug that needs to be processed and planned by the docs project owners
on Jun 2, 2025
jmacdotorg

jmacdotorg commented on Jun 2, 2025

@jmacdotorg
ContributorAuthor

#363 might be a sub-task of this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @jmacdotorg

        Issue actions

          Add an "anatomy of a review" doc? · Issue #358 · coderabbitai/coderabbit-docs