diff --git a/docs/guides/code-review-best-practices.md b/docs/guides/code-review-best-practices.md index 426617e8..65569ce0 100644 --- a/docs/guides/code-review-best-practices.md +++ b/docs/guides/code-review-best-practices.md @@ -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 diff --git a/docs/reference/review-commands.md b/docs/reference/review-commands.md index dc3c97b8..bac14a92 100644 --- a/docs/reference/review-commands.md +++ b/docs/reference/review-commands.md @@ -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 |