docs: improve wording and fix minor text issues in installation documentation#2294
Open
DoraC7 wants to merge 1 commit intoqodo-ai:mainfrom
Open
docs: improve wording and fix minor text issues in installation documentation#2294DoraC7 wants to merge 1 commit intoqodo-ai:mainfrom
DoraC7 wants to merge 1 commit intoqodo-ai:mainfrom
Conversation
…stallation docs Description Fix minor wording, punctuation, and capitalization issues in the installation documentation. Changes Corrected Bitbucket capitalization Improved wording for the OpenAI API key description Refined sentence structure for better clarity and readability Notes These changes are documentation-only and do not affect runtime behavior.
Contributor
Review Summary by QodoFix wording and capitalization in installation documentation
WalkthroughsDescription• Corrected "BitBucket" capitalization to "Bitbucket" throughout • Improved OpenAI key description wording for clarity • Refined sentence structure in environment variables section • Enhanced readability of configuration documentation Diagramflowchart LR
A["Installation Docs"] -->|"Fix capitalization"| B["BitBucket → Bitbucket"]
A -->|"Improve wording"| C["OpenAI key description"]
A -->|"Refine sentences"| D["Environment variables section"]
B --> E["Updated docs"]
C --> E
D --> E
File Changes1. docs/docs/installation/locally.md
|
Contributor
Code Review by Qodo
1. Grammar: another models
|
![qodo-free-for-open-source-projects[bot]](https://avatars.githubusercontent.com/in/1068000?s=60&v=4){kind=small}
|
|
||
| 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). |
Contributor
There was a problem hiding this comment.
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
| 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). | ||
| 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"} |
Contributor
There was a problem hiding this comment.
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fix minor wording, punctuation, and capitalization issues in the installation documentation.
Changes
Notes
These changes are documentation-only and do not affect runtime behavior.