From 94e1126b003f056f0da2e53e0af591fa4d510333 Mon Sep 17 00:00:00 2001 From: Judonguk Date: Sun, 25 May 2025 11:09:11 +0900 Subject: [PATCH] add docs about Mermaid Diagram --- docs/docs/tools/describe.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md index 0f2c45a7..4f4e2232 100644 --- a/docs/docs/tools/describe.md +++ b/docs/docs/tools/describe.md @@ -1,6 +1,18 @@ ## Overview The `describe` tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. +### Mermaid Diagram Support +When the `add_diagram` option is enabled in your configuration, the `/describe` tool will include a `Mermaid` sequence diagram in the PR description. + +This diagram represents interactions between components/functions based on the diff content. + +### How to enable + +In your configuration: + +toml +[pr_description] +add_diagram = true The tool can be triggered automatically every time a new PR is [opened](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened), or it can be invoked manually by commenting on any PR: @@ -109,6 +121,10 @@ Everything below this marker is treated as previously auto-generated content and enable_help_text If set to true, the tool will display a help text in the comment. Default is false. + + add_diagram + If set to true, the tool will generate a Mermaid sequence diagram (in code block format) describing component interactions based on the code changes. Default is false. + ## Inline file summary 💎