xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-02 11:50:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: enable PR diagram by default and improve mermaid diagram generation

Browse Source
This commit is contained in:
mrT23
2025-06-24 17:28:23 +03:00
parent e75b863f3b
commit ead2c9273f
4 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/docs/tools/describe.md
View File

@ -59,17 +59,23 @@ Everything below this marker is treated as previously auto-generated content and
### Sequence Diagram Support
When the `enable_pr_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.
This diagram represents interactions between components/functions based on the PR content.
### How to enable
[//]: # (### How to enable\disable)
In your configuration:
[//]: # ()
[//]: # (In your configuration:)
```
toml
[pr_description]
enable_pr_diagram = true
```
[//]: # ()
[//]: # (```)
[//]: # (toml)
[//]: # ([pr_description])
[//]: # (enable_pr_diagram = true)
[//]: # (```)
## Configuration options
@ -126,7 +132,7 @@ enable_pr_diagram = true
</tr>
<tr>
<td><b>enable_pr_diagram</b></td>
<td>If set to true, the tool will generate a horizontal Mermaid flowchart summarizing the main pull request changes. This field remains empty if not applicable. Default is false.</td>
<td>If set to true, the tool will generate a horizontal Mermaid flowchart summarizing the main pull request changes. This field remains empty if not applicable. Default is true.</td>
</tr>
</table>