You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains 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
Add a brief explanation of PR-Agent to provide context for new users
Consider adding a brief explanation of what PR-Agent is and how it relates to this Chrome extension. This will provide better context for new users who might not be familiar with PR-Agent.
## PR-Agent chrome extension
-[PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) is a collection of tools that integrates seamlessly with your GitHub environment, aiming to enhance your PR-Agent usage experience, and providing additional features.+PR-Agent is an AI-powered tool that helps streamline the pull request review process. The [PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) is a collection of tools that integrates seamlessly with your GitHub environment, aiming to enhance your PR-Agent usage experience and provide additional features.
Apply this suggestion
Suggestion importance[1-10]: 8
Why: This suggestion provides valuable context for new users, enhancing the documentation's clarity and usefulness.
8
Provide more specific instructions on how to access the PR Chat feature
Consider adding information about how to access the PR Chat feature after installation. This will help users quickly locate and start using the new feature.
-To enable private chat, simply install the PR-Agent Chrome extension. After installation, each PR's file-changed tab will include a chat box, where you may ask questions about your code.+To enable private chat, simply install the PR-Agent Chrome extension. After installation, navigate to any pull request on GitHub and click on the "Files changed" tab. You'll see a new chat box at the bottom of the page where you can ask questions about your code.
Apply this suggestion
Suggestion importance[1-10]: 7
Why: The suggestion offers more detailed guidance, which can improve user experience, but the existing instructions are already fairly clear.
7
Provide more information about PR-Agent Pro and its necessity for private repositories
Consider adding a brief explanation of what PR-Agent Pro is and how it differs from the regular PR-Agent. This will help users understand why they need PR-Agent Pro for private repositories.
-All open-source repositories are supported. For private repositories, you will also need to install PR-Agent Pro.+All open-source repositories are supported with the standard PR-Agent Chrome extension. For private repositories, you will need to install PR-Agent Pro, our premium version that offers enhanced security features and support for private code bases.
Apply this suggestion
Suggestion importance[1-10]: 7
Why: This suggestion adds valuable information about PR-Agent Pro, which could help users make informed decisions about using the tool for private repositories.
7
Best practice
Add information about potential limitations of the PR Chat feature
Consider adding information about any limitations or constraints of the PR Chat feature, such as the maximum context size or any rate limits. This will help set user expectations and prevent potential frustration.
-The PR-Chat feature allows to freely chat with your PR code, within your GitHub environment.-It will seamlessly add the PR code as context to your chat session, and provide AI-powered feedback.+The PR-Chat feature allows you to freely chat with your PR code within your GitHub environment.+It will seamlessly add the PR code as context to your chat session and provide AI-powered feedback.+Please note that there may be limitations on the amount of code context that can be processed, and usage may be subject to rate limits depending on your plan.
Apply this suggestion
Suggestion importance[1-10]: 6
Why: While useful, this suggestion addresses a minor issue. The information is helpful but not critical for basic usage of the feature.
✅ Expand on the security and privacy aspects of the PR-Chat featureSuggestion Impact:The commit expanded on the security and privacy aspects of the PR-Chat feature by adding a section that emphasizes the importance of security and privacy, similar to the suggestion.
code diff:
+#### Chat security and privacy++We take your code's security and privacy seriously:++- The Chrome extension does not send any code to external servers.+- For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing PR-Agent Pro integration.
Consider adding more details about the security and privacy aspects of the PR-Chat feature. This will help address potential concerns users might have about using the tool.
-The Chrome extension will not send any code to the server.-To access code from private repositories, we will first validate the user's identity and permissions, then generate responses using the existing PR-Agent Pro integration.+### Security and Privacy+We take your code's security and privacy seriously:++- The Chrome extension does not send any code to external servers.+- For private repositories, we use secure authentication to validate the user's identity and permissions.+- Responses are generated using the existing PR-Agent Pro integration, ensuring your code stays within your trusted environment.+- All communication is encrypted and follows best practices for data protection.++For more details on our security measures, please refer to our [Security Policy](link-to-security-policy).+
Suggestion importance[1-10]: 9
Why: Addressing security and privacy concerns is critical, especially for a tool handling code. This suggestion significantly enhances user trust and provides important information.
9
Enhancement
Add installation instructions for the PR-Agent Chrome extension
Consider adding information about how to install the PR-Agent Chrome extension. This will make it easier for users to get started with the tool.
+## Installation++To install the PR-Agent Chrome extension:+1. Visit the [Chrome Web Store page](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl).+2. Click on "Add to Chrome" button.+3. Confirm the installation when prompted.+
## Features
### PR Chat
-The PR-Chat feature allows to freely chat with your PR code, within your GitHub environment.+The PR-Chat feature allows you to freely chat with your PR code within your GitHub environment.
Suggestion importance[1-10]: 8
Why: Installation instructions are crucial for user adoption and were missing from the original document. This addition significantly improves user experience.
8
Add a brief explanation of PR-Agent at the beginning of the document
Consider adding a brief explanation of what PR-Agent is at the beginning of the document. This will provide context for readers who might not be familiar with the tool.
-## PR-Agent chrome extension-[PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) is a collection of tools that integrates seamlessly with your GitHub environment, aiming to enhance your PR-Agent usage experience, and providing additional features.+## PR-Agent Chrome Extension+PR-Agent is an AI-powered tool that helps streamline the pull request review process. The [PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) is a collection of tools that integrates seamlessly with your GitHub environment, aiming to enhance your PR-Agent usage experience and provide additional features.
Suggestion importance[1-10]: 7
Why: The suggestion provides useful context for new users, enhancing the document's clarity and accessibility.
7
Add a troubleshooting and FAQ section to address common user issues
Consider adding a section about troubleshooting or FAQ to address common issues users might encounter when using the PR-Agent Chrome extension.
After you found the setup that works for you, you can also easily export it as a persistent configuration file, and use it for automatic commands.
+## Troubleshooting and FAQ++### Q: The PR-Chat feature is not appearing in my GitHub PR.+A: Ensure that you have installed the latest version of the PR-Agent Chrome extension and that it's enabled in your browser. If the issue persists, try refreshing the page or restarting your browser.++### Q: Can I use PR-Chat with private repositories?+A: Yes, but you'll need to install PR-Agent Pro in addition to the Chrome extension. See the [PR-Agent Pro documentation](link-to-pro-docs) for more information.++For more questions or issues, please visit our [support forum](link-to-support-forum) or [open an issue](link-to-github-issues) on our GitHub repository.+
Suggestion importance[1-10]: 7
Why: A troubleshooting section can greatly improve user experience by preemptively addressing common issues, though it's not as critical as security or installation information.
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.
qodo-merge-pro
bot
added
documentation
PR Type
Enhancement, Documentation
Description
Changes walkthrough 📝
index.md
Add PR-Chat feature documentationdocs/docs/chrome-extension/index.md