docs: update PR-Agent documentation with PR Chat search instructions

[mrT23]

PR Type

Documentation, Enhancement

---

Description

• Added a new section "PR-Agent Docs Smart Search" to provide clearer instructions on how to use the documentation search feature
• Expanded the search functionality to include PR Chat, in addition to pull requests
• Improved the formatting and structure of the instructions for better readability
• Updated the existing content to be more comprehensive and user-friendly

---

Changes walkthrough 📝

	Relevant files
Documentation	index.md Enhance documentation search instructions                                docs/docs/index.md Expanded instructions for using PR-Agent's documentation search feature Added a new section "PR-Agent Docs Smart Search" with step-by-step guide Included information about using the feature in PR Chat +11/-1

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[qodo-merge-pro]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🏅 Score: 95

🧪 No relevant tests

🔒 No security concerns identified

🔀 No multiple PR themes

⚡ No key issues to review

[qodo-merge-pro]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Enhancement	Add an example question to demonstrate the usage of the /help command Consider adding an example question to illustrate how users can formulate their queries when using the /help command. This will help users understand how to effectively use the feature. docs/docs/index.md [16-18] 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) +Example: `/help "How do I configure PR-Agent for my repository?"` + Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding an example question significantly improves the usability of the feature by demonstrating its practical application. This concrete example will help users formulate effective queries.	8
	Add a brief introduction to PR-Agent before the search instructions Consider adding a brief explanation of what PR-Agent is and how it can help users before diving into the search instructions. This will provide context for new users who might not be familiar with the tool. docs/docs/index.md [12-14] ## PR-Agent Docs Smart Search + +PR-Agent is an AI-powered tool that assists with pull request management and code review. One of its features is the ability to search documentation using natural language queries. To search the documentation site using natural language: Apply this suggestion Suggestion importance[1-10]: 7 Why: This suggestion provides valuable context for new users, enhancing the documentation's clarity and user-friendliness. It's a moderate improvement that aids in understanding the tool's purpose.	7
Best practice	Add information about limitations and best practices for using the documentation search feature Consider adding information about any limitations or best practices when using the documentation search feature. This will help users understand how to get the most out of the tool and set appropriate expectations. docs/docs/index.md [20] 2. PR-Agent will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links. +Note: For best results, try to be specific in your questions and provide context when necessary. The search feature works best with clear, concise queries related to PR-Agent's functionality and configuration. + Apply this suggestion Suggestion importance[1-10]: 6 Why: This suggestion enhances the user experience by setting appropriate expectations and providing guidance for optimal use. It's a useful addition, though not as critical as the previous suggestions.	6

💡 Need additional feedback ? start a PR chat