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

docs: clarify that PR diagram is enabled by default in describe tool

Browse Source
This commit is contained in:
mrT23
2025-06-29 11:24:31 +03:00
parent 9115cb7d31
commit 2eb8019325
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -57,9 +57,10 @@ Everything below this marker is treated as previously auto-generated content and
![Describe comment](https://codium.ai/images/pr_agent/pr_description_user_description.png){width=512}
### 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.
The `/describe` tool includes a Mermaid sequence diagram in PR descriptions showing component/function interactions.
This option is enabled by default via the `pr_description.enable_pr_diagram` param.
This diagram represents interactions between components/functions based on the PR content.
[//]: # (### How to enable\disable)