Skip to content

docs: Document generate sequence diagram command #497

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.

Sign up for GitHub

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Document generate sequence diagram command #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/guides/code-review-best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ For a CodeRabbit command reference, see [Code review command reference](/referen
- Use `@coderabbitai pause` before making multiple commits.
- Resume reviews with `@coderabbitai resume` when ready.
- Consider `@coderabbitai full review` after substantial changes.
- Consider generating a fresh sequence diagram with `@coderabbitai generate sequence diagram` after significant updates.

## Documentation flow

Expand Down
1 change: 1 addition & 0 deletions docs/reference/review-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ CodeRabbit through chat, see [Interact with CodeRabbit reviews](/guides/code-rev
| Command | Description | Use Case |
| ----------------------------------- | -------------------------------------------- | --------------------------------------------------- |
| `@coderabbitai generate docstrings` | Generates docstrings for functions in the PR | When you need automatic documentation for your code |
| `@coderabbitai generate sequence diagram` | Generates a sequence diagram of the changes in this PR | When you need a UML sequence diagram to visually explain the changed code |
| `@coderabbitai generate unit tests` | Generates unit tests for the PR | When you need automatic unit testing for your code |
| `@coderabbitai configuration` | Shows current CodeRabbit settings | When you need to check or export your configuration |

Expand Down