diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md index d8d074a6..9b47e3c7 100644 --- a/docs/docs/tools/describe.md +++ b/docs/docs/tools/describe.md @@ -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 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) diff --git a/docs/docs/usage-guide/additional_configurations.md b/docs/docs/usage-guide/additional_configurations.md index 98ed8472..17b49cf9 100644 --- a/docs/docs/usage-guide/additional_configurations.md +++ b/docs/docs/usage-guide/additional_configurations.md @@ -260,5 +260,5 @@ To automatically exclude files generated by specific languages or frameworks, yo ignore_language_framework = ['protobuf', ...] ``` -You can view the list of auto-generated file patterns in `generated_code_ignore.toml`. +You can view the list of auto-generated file patterns in [`generated_code_ignore.toml`](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/generated_code_ignore.toml). Files matching these glob patterns will be automatically excluded from PR Agent analysis. \ No newline at end of file