Skip to content

Commit df36de3

Browse files
Fix stale docs links and navigation targets (#2232)
Replace stale references in model and configuration docs to point at current files that exist in this repository. Use .secrets_template.toml instead of the removed ai_handler.py path for model-provider key setup guidance. Normalize the configuration.toml GitHub link by removing a trailing slash so the file URL remains stable. Fix the "Chat on code suggestions" links in docs index and summary to point to core-abilities/interactivity.md.
1 parent bca4ee2 commit df36de3

9 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ PR-Agent offers comprehensive pull request functionalities integrated with vario
4040
| | [Actions](./installation/github.md#run-as-a-github-action) ||||| |
4141
| | | | | | | |
4242
| [CORE](./core-abilities/index.md) | [Adaptive and token-aware file patch fitting](./core-abilities/compression_strategy.md) ||||| |
43-
| | [Chat on code suggestions](./core-abilities/chat_on_code_suggestions.md) ||| | | |
43+
| | [Chat on code suggestions](./core-abilities/interactivity.md) ||| | | |
4444
| | [Compression strategy](./core-abilities/compression_strategy.md) ||||| |
4545
| | [Dynamic context](./core-abilities/dynamic_context.md) ||||| |
4646
| | [Fetching ticket context](./core-abilities/fetching_ticket_context.md) |||| | |

docs/docs/summary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
## Core Abilities
3737

3838
* [Core Abilities](core-abilities/index.md)
39-
* [Chat on code suggestions](core-abilities/chat_on_code_suggestions.md)
39+
* [Chat on code suggestions](core-abilities/interactivity.md)
4040
* [Compression strategy](core-abilities/compression_strategy.md)
4141
* [Dynamic context](core-abilities/dynamic_context.md)
4242
* [Fetching ticket context](core-abilities/fetching_ticket_context.md)

docs/docs/tools/help_docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ When a new issue is opened, you should see a comment from `github-actions` bot w
100100

101101
## Configuration options
102102

103-
Under the section `pr_help_docs`, the [configuration file](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L50) contains options to customize the 'help docs' tool:
103+
Under the section `pr_help_docs`, the [configuration file](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L199) contains options to customize the 'help docs' tool:
104104

105105
- `repo_url`: If not overwritten, will use the repo from where the context came from (issue or PR), otherwise - use the given repo as context.
106106
- `repo_default_branch`: The branch to use in case repo_url overwritten, otherwise - has no effect.

docs/docs/tools/review.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,8 @@ extra_instructions = "..."
159159

160160
The `review` can tool automatically add labels to your Pull Requests:
161161

162-
- **`possible security issue`**: This label is applied if the tool detects a potential [security vulnerability](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L103) in the PR's code. This feedback is controlled by the 'enable_review_labels_security' flag (default is true).
163-
- **`review effort [x/5]`**: This label estimates the [effort](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L90) required to review the PR on a relative scale of 1 to 5, where 'x' represents the assessed effort. This feedback is controlled by the 'enable_review_labels_effort' flag (default is true).
162+
- **`possible security issue`**: This label is applied if the tool detects a potential [security vulnerability](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L121) in the PR's code. This feedback is controlled by the 'enable_review_labels_security' flag (default is true).
163+
- **`review effort [x/5]`**: This label estimates the [effort](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L105) required to review the PR on a relative scale of 1 to 5, where 'x' represents the assessed effort. This feedback is controlled by the 'enable_review_labels_effort' flag (default is true).
164164
- **`ticket compliance`**: Adds a label indicating code compliance level ("Fully compliant" | "PR Code Verified" | "Partially compliant" | "Not compliant") to any GitHub/Jira/Linea ticket linked in the PR. Controlled by the 'require_ticket_labels' flag (default: false). If 'require_no_ticket_labels' is also enabled, PRs without ticket links will receive a "No ticket found" label.
165165

166166

docs/docs/tools/similar_issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ You can get a free managed Qdrant instance from [Qdrant Cloud](https://cloud.qdr
6868
- To invoke the 'similar' issue tool via online usage, [comment](https://github.com/qodo-ai/pr-agent/issues/178#issuecomment-1716934893) on a PR:
6969
`/similar_issue`
7070

71-
- You can also enable the 'similar issue' tool to run automatically when a new issue is opened, by adding it to the [pr_commands list in the github_app section](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L66)
71+
- You can also enable the 'similar issue' tool to run automatically when a new issue is opened, by adding it to the [pr_commands list in the github_app section](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L229)

docs/docs/tools/update_changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ It can be invoked manually by commenting on any PR:
1515

1616
## Configuration options
1717

18-
Under the section `pr_update_changelog`, the [configuration file](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L50) contains options to customize the 'update changelog' tool:
18+
Under the section `pr_update_changelog`, the [configuration file](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L169) contains options to customize the 'update changelog' tool:
1919

2020
- `push_changelog_changes`: whether to push the changes to CHANGELOG.md, or just publish them as a comment. Default is false (publish as comment).
2121
- `extra_instructions`: Optional extra instructions to the tool. For example: "Use the following structure: ..."

docs/docs/usage-guide/automations_and_usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ verbosity_level=2
2929

3030
This is useful for debugging or experimenting with different tools.
3131

32-
3. **git provider**: The [git_provider](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in a configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported:
32+
3. **git provider**: The [git_provider](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L12) field in a configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported:
3333
`github` **(default)**, `gitlab`, `bitbucket`, `azure`, `codecommit`, `local`, and `gitea`.
3434

3535
### CLI Health Check
@@ -96,7 +96,7 @@ When this parameter is set to `true`, PR-Agent will not run any automatic tools
9696

9797
#### GitHub app automatic tools when a new PR is opened
9898

99-
The [github_app](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L220) section defines GitHub app specific configurations.
99+
The [github_app](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L223) section defines GitHub app specific configurations.
100100

101101
The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when a new PR is opened:
102102

docs/docs/usage-guide/changing_a_model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
See [here](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/algo/__init__.py) for a list of supported models in PR-Agent.
44
The default model of PR-Agent is `GPT-5` from OpenAI.
5-
To use a different model than the default, you need to edit in the [configuration file](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L2) the fields:
5+
To use a different model than the default, you need to edit in the [configuration file](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L7) the fields:
66

77
```toml
88
[config]
@@ -145,7 +145,7 @@ key = ...
145145

146146
(you can obtain a Llama2 key from [here](https://replicate.com/replicate/llama-2-70b-chat/api))
147147

148-
Also, review the [AiHandler](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/algo/ai_handler.py) file for instructions on how to set keys for other models.
148+
Also, review the [.secrets_template.toml](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/.secrets_template.toml) file for instructions on how to set keys for other models.
149149

150150
### Groq
151151

docs/docs/usage-guide/configuration_options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ There are three main ways to set persistent configurations:
88
In terms of precedence, wiki configurations will override local configurations, and local configurations will override global configurations.
99

1010

11-
For a list of all possible configurations, see the [configuration options](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml/) page.
12-
In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L16) section in the configuration file.
11+
For a list of all possible configurations, see the [configuration options](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) page.
12+
In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L66) section in the configuration file.
1313

1414
!!! tip "Tip1: Edit only what you need"
1515
Your configuration file should be minimal, and edit only the relevant values. Don't copy the entire configuration options, since it can lead to legacy problems when something changes.

0 commit comments

Comments
 (0)