xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-02 03:40:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1257 from Codium-ai/tr/code_suggestion_message

Browse Source 
docs: update PR-Agent documentation with PR Chat search instructions
This commit is contained in:
Tal
2024-09-27 16:15:09 +03:00
committed by GitHub
parent 267e01409b 57cfdcf274
commit 6188afff48
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/index.md
View File

@ -8,9 +8,19 @@ CodiumAI PR-Agent is an open-source tool to help efficiently review and handle p
- See the [Tools Guide](./tools/index.md) for a detailed description of the different tools.
To search the documentation site using natural language, simply comment `/help "your question"` in a pull request where PR-Agent is installed. PR-Agent will then provide you with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334), including relevant documentation links.
## PR-Agent Docs Smart Search
To search the documentation site using natural language:
1. Comment `/help "your question"` in either:
- A pull request where PR-Agent is installed
- A [PR Chat](https://pr-agent-docs.codium.ai/chrome-extension/features/#pr-chat)
2. PR-Agent will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links.
## PR-Agent Features
PR-Agent offers extensive pull request functionalities across various git providers.
| | | GitHub | Gitlab | Bitbucket | Azure DevOps |