docs: Document generate sequence diagram command

[0xCLARITY]

The @coderabbitai generate sequence diagram is an existing feature/command that is somewhat documented in that it is returned by @coderabbitai help and in https://docs.coderabbit.ai/guides/commands#diagram-the-pull-request-history%E2%80%8B.

However, it was not listed in the reference page that should list all commands, nor was it mentioned in the best practice page.

This PR addresses that by adding it to both pages in a relevant fashion.

Changes

• Add generate sequence diagram to the reference for PR review commands
• Suggest generate sequence diagram under PR review best practices after large changes

Summary by CodeRabbit

• Documentation
  • Recommend generating a fresh sequence diagram after significant updates to improve clarity when reviewing large changes.
  • Added the “@coderabbitai generate sequence diagram” command to reference docs with usage examples and suggested scenarios.
  • Expanded reference tables and examples to include the new command for easier discovery and consistent reviewer workflows.

[coderabbitai]

Caution

Review failed

Failed to post review comments.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c3e91e5 and ef5e6b8.

📒 Files selected for processing (2)

• docs/guides/code-review-best-practices.md (1 hunks)
• docs/reference/review-commands.md (1 hunks)

🧰 Additional context used

🔍 MCP Research (1 server)

Notion:

• Document [Sequence diagrams]: page states the system "now generates sequence diagrams for code changes, providing reviewers with a clear visualization of the control flow for improved understanding." (Notion page ID: 21596e76-cda1-809d-a319-e343d3da3104, https://www.notion.so/21596e76cda1809da319e343d3da3104)
• Document [Feature Matrix]: shows a "Sequence Diagrams" row in the feature matrix with availability flags (table entry: "Sequence Diagrams ❌ ❌ ✅ ✅ ❌ ❌"), indicating which products/components support sequence diagram generation. (Notion page ID: 17c96e76-cda1-8085-88fc-dd7d5acd51b5, https://www.notion.so/17c96e76cda1808588fcdd7d5acd51b5)
• Document [Prompting]: contains guidance related to documentation generation and mentions generation behaviors; includes a line about producing improved outputs without certain functions and references documentation generation practices that may be relevant to how the sequence-diagram command is prompted/used. (Notion page ID: 1c796e76-cda1-80e1-ba11-e67d2c4af989, https://www.notion.so/1c796e76cda180e1ba11e67d2c4af989)

📝 Walkthrough

Walkthrough

Added documentation guidance and reference entries: a new bullet in docs/guides/code-review-best-practices.md advising to run @coderabbitai generate sequence diagram after significant updates, and added the @coderabbitai generate sequence diagram command to docs/reference/review-commands.md (examples and commands table). No code changes.

Changes

Cohort / File(s)	Summary
Guides update docs/guides/code-review-best-practices.md	Added a bullet in “Managing large changes” recommending running @coderabbitai generate sequence diagram after significant updates.
Reference commands docs docs/reference/review-commands.md	Inserted @coderabbitai generate sequence diagram into the Documentation commands table and into example usages, describing purpose and use case.

Sequence Diagram(s)

sequenceDiagram
  participant Reviewer as Reviewer (PR)
  participant Comment as Repo Comment
  participant CodeRabbit as CodeRabbit AI
  Reviewer->>Comment: Post "@coderabbitai generate sequence diagram"
  Comment->>CodeRabbit: Request: generate sequence diagram for PR changes
  CodeRabbit-->>Comment: Respond with generated sequence diagram (image/markdown)
  Comment-->>Reviewer: Diagram available in thread

Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my whiskers, diagrams in sight,
Arrows hop and protocols take flight.
A tiny command, a gentle ping,
Diagrams bloom — reviewers sing.
Thump-thump — carrots mapped in light. 🥕✨

Pre-Merge Checks (3 passed)

✅ Passed Checks (3 passed)

Check Name	Status	Explanation
Title Check	✅ Passed	The title is concise, specific, and accurately describes documenting the generate sequence diagram command.
Description Check	✅ Passed	The description clearly outlines the context, changes, and rationale for adding the generate sequence diagram command; consider adding a pull request template to standardize future descriptions.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[0xCLARITY]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.