Skip to content

docs: improve wording and fix minor text issues in installation documentation #2294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DoraC7 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −7
Open

docs: improve wording and fix minor text issues in installation documentation #2294

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/docs/installation/locally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
To run PR-Agent locally, you first need to acquire two keys:

1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 and o4-mini (or a key for other [language models](../usage-guide/changing_a_model.md), if you prefer).
2. A personal access token from your Git platform (GitHub, GitLab, BitBucket, Gitea) with repo scope. GitHub token, for example, can be issued from [here](https://github.com/settings/tokens){:target="_blank"}
1. An OpenAI API key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 and o4-mini (or another [language models](../usage-guide/changing_a_model.md), if you prefer).
Copy link
Copy Markdown
Contributor

@qodo-free-for-open-source-projects qodo-free-for-open-source-projects bot Mar 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

1. Grammar: another models 🐞 Bug ⚙ Maintainability

The OpenAI key bullet says "or another language models", which is grammatically incorrect (singular
"another" with plural "models") and makes the alternative-model option unclear.
Agent Prompt 
### Issue description
The text uses an ungrammatical phrase: `another [language models]`.

### Issue Context
This is in the prerequisite keys list at the top of the local installation guide.

### Fix Focus Areas
- docs/docs/installation/locally.md[3-3]

### Suggested change
Update to either:
- `... (or other [language models](../usage-guide/changing_a_model.md), if you prefer).`

or
- `... (or another [language model](../usage-guide/changing_a_model.md), if you prefer).`

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

2. A personal access token from your Git platform (GitHub, GitLab, Bitbucket, Gitea) with repo scope. GitHub token. For example, you can create a GitHub token [here](https://github.com/settings/tokens){:target="_blank"}
Copy link
Copy Markdown
Contributor

@qodo-free-for-open-source-projects qodo-free-for-open-source-projects bot Mar 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

2. Sentence fragment: github token 🐞 Bug ⚙ Maintainability

The personal access token bullet now contains a standalone "GitHub token." sentence fragment, which
breaks the sentence and reduces clarity.
Agent Prompt 
### Issue description
`GitHub token.` is a sentence fragment inserted between two complete sentences.

### Issue Context
This is the prerequisites list for running PR-Agent locally.

### Fix Focus Areas
- docs/docs/installation/locally.md[4-4]

### Suggested change
Rewrite as a single coherent sentence, e.g.:
- `2. A personal access token from your Git platform (GitHub, GitLab, Bitbucket, Gitea) with repo scope. For example, you can create a GitHub token [here](https://github.com/settings/tokens){:target="_blank"}.`

(Or similar wording, but remove the standalone `GitHub token.` fragment.)

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


## Using Docker image

Expand Down Expand Up @@ -34,7 +34,7 @@ To invoke a tool (for example `review`), you can run PR-Agent directly from the
-e GITLAB.URL=<your gitlab instance url>
```

- For BitBucket:
- For Bitbucket:

```bash
docker run --rm -it -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN codiumai/pr-agent:latest --pr_url=<pr_url> review
Expand All @@ -53,13 +53,13 @@ To invoke a tool (for example `review`), you can run PR-Agent directly from the
```


For other git providers, update `CONFIG.GIT_PROVIDER` accordingly and check the [`pr_agent/settings/.secrets_template.toml`](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/.secrets_template.toml) file for environment variables expected names and values.
For other git providers, update `CONFIG.GIT_PROVIDER` accordingly and check the [`pr_agent/settings/.secrets_template.toml`](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/.secrets_template.toml) file for the expected names and values of environment variables.

### Utilizing environment variables

It is also possible to provide or override the configuration by setting the corresponding environment variables.
You can define the corresponding environment variables by following this convention: `<TABLE>__<KEY>=<VALUE>` or `<TABLE>.<KEY>=<VALUE>`.
The `<TABLE>` refers to a table/section in a configuration file and `<KEY>=<VALUE>` refers to the key/value pair of a setting in the configuration file.
You can also provide or override the configuration by setting the corresponding environment variables.
You can define the corresponding environment variables using the following convention: `<TABLE>__<KEY>=<VALUE>` or `<TABLE>.<KEY>=<VALUE>`.
`<TABLE>` refers to a section in a configuration file and `<KEY>=<VALUE>` refers to the key/value pair of a setting in the configuration file.

For example, suppose you want to run `pr_agent` that connects to a self-hosted GitLab instance similar to an example above.
You can define the environment variables in a plain text file named `.env` with the following content:
Expand Down