diff --git a/README.md b/README.md index 0411888c..a307391a 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ We are very happy to share our new paper: Go checkout our official implementation [here](https://github.com/Codium-ai/AlphaCodium) ### Jan 17, 2024 -- 💎 Inline file summary - The `describe` tool now supports a new option `--pr_description.inline_file_summary`, which allows to add a summary of each file changes to the Diffview page. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/Describe.md#inline-file-summary) +- 💎 Inline file summary - The `describe` tool has a new option `--pr_description.inline_file_summary`, which allows to add a summary of each file changes to the Diffview page. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#inline-file-summary-) - The `improve` tool now can present suggestion in a nice collapsible format, which significantly reduces the PR footprint. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md#summarized-vs-commitable-code-suggestions) for more details. - To accompany the improved interface of the `improve` tool, we change the [default automation settings](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L116) of our GithupApp to: ``` @@ -158,7 +158,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the d | | ⮑ [SOC2 Compliance](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-compliance-) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Ask | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Describe | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | ⮑ [Inline file summary](https://github.com/Codium-ai/pr-agent/blob/main/docs/Describe.md#inline-file-summary) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| | ⮑ [Inline file summary](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#inline-file-summary-) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Improve | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | ⮑ Extended | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Reflect and Review | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 83c6defb..019d39c6 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -2,6 +2,7 @@ ## Table of Contents - [Overview](#overview) - [Configuration options](#configuration-options) + - [Inline file summary 💎](#inline-file-summary-) - [Handle custom labels from the Repo's labels page :gem:](#handle-custom-labels-from-the-repos-labels-page-gem) - [Markers template](#markers-template) - [Usage Tips](#usage-tips)