Skip to content

Commit ef5e6b8

Browse files
committed
Document generate sequence diagram command
1 parent c3e91e5 commit ef5e6b8

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

docs/guides/code-review-best-practices.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ For a CodeRabbit command reference, see [Code review command reference](/referen
2222
- Use `@coderabbitai pause` before making multiple commits.
2323
- Resume reviews with `@coderabbitai resume` when ready.
2424
- Consider `@coderabbitai full review` after substantial changes.
25+
- Consider generating a fresh sequence diagram with `@coderabbitai generate sequence diagram` after significant updates.
2526

2627
## Documentation flow
2728

docs/reference/review-commands.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ CodeRabbit through chat, see [Interact with CodeRabbit reviews](/guides/code-rev
3232
| Command | Description | Use Case |
3333
| ----------------------------------- | -------------------------------------------- | --------------------------------------------------- |
3434
| `@coderabbitai generate docstrings` | Generates docstrings for functions in the PR | When you need automatic documentation for your code |
35+
| `@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 |
3536
| `@coderabbitai generate unit tests` | Generates unit tests for the PR | When you need automatic unit testing for your code |
3637
| `@coderabbitai configuration` | Shows current CodeRabbit settings | When you need to check or export your configuration |
3738

0 commit comments

Comments
 (0)