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

Merge pull request #1824 from OSSCA-2025-Egg-Benedict/feature/sequence-diagram

Browse Source 
Improve/describe tool documentation and make add_diagram feature opt-in by default
This commit is contained in:
Tal
2025-05-25 13:44:53 +03:00
committed by GitHub
parent 2453508023 d2194c7ed9
commit 946657a6d1
4 changed files with 43 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -56,6 +56,21 @@ 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.
This diagram represents interactions between components/functions based on the diff content.
### How to enable
In your configuration:
```
toml
[pr_description]
enable_pr_diagram = true
```
## Configuration options
!!! example "Possible configurations"
@ -109,6 +124,10 @@ Everything below this marker is treated as previously auto-generated content and
<td><b>enable_help_text</b></td>
<td>If set to true, the tool will display a help text in the comment. Default is false.</td>
</tr>
<tr>
<td><b>add_diagram</b></td>
<td>If set to true, the tool will generate a <code>Mermaid</code> sequence diagram (in code block format) describing component interactions based on the code changes. Default is false.</td>
</tr>
</table>
## Inline file summary 💎