Tr/docs best practice

[mrT23]

PR Type

Documentation, Enhancement

---

Description

• Added comprehensive documentation for 'Auto Best Practices' feature.

• Updated configuration files to include 'auto_best_practices' settings.

• Enhanced documentation for suggestion tracking and best practices usage.

• Linked 'Auto Best Practices' in navigation and core abilities index.

---

Changes walkthrough 📝

	Relevant files
Documentation	auto_best_practices.md Added 'Auto Best Practices' feature documentation                docs/docs/core-abilities/auto_best_practices.md Introduced detailed documentation for 'Auto Best Practices'. Explained its functionality, configurations, and usage. Highlighted differences between auto and custom best practices. Included relevant configuration examples. +64/-0    index.md Linked 'Auto Best Practices' in core abilities index          docs/docs/core-abilities/index.md Added a link to 'Auto Best Practices' documentation. +1/-0      improve.md Updated 'improve' tool documentation with auto best practices docs/docs/tools/improve.md Enhanced explanation of suggestion tracking. Added section for 'Auto Best Practices' with configurations. +37/-2    pr_code_suggestions_prompts.toml Updated field description in code suggestions prompts        pr_agent/settings/pr_code_suggestions_prompts.toml Clarified description for 'existing_code' field in code suggestions. +2/-2
Configuration changes	mkdocs.yml Updated navigation to include 'Auto Best Practices'            docs/mkdocs.yml Added 'Auto Best Practices' to the navigation structure. +1/-0      configuration.toml Added 'auto_best_practices' configuration settings              pr_agent/settings/configuration.toml Added 'auto_best_practices' configuration section. Defined flags and parameters for enabling and customizing auto best practices. +9/-0

---

Need help?

Type /help how to ... in the comments thread for any questions about Qodo Merge usage.

Check out the documentation for more information.

[qodo-merge-pro-for-open-source]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

🏅 Score: 95

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Broken Link The image link for auto best practices uses qodo.ai domain which may not be the correct domain for hosting documentation images {width=512}

[qodo-merge-pro-for-open-source]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible issue	Fix broken image link Fix the broken image link by updating the domain from 'qodo.ai' to 'codium.ai' to match the repository's actual domain, ensuring the image is properly displayed. docs/docs/core-abilities/auto_best_practices.md [34] -{width=512} +{width=512} Apply this suggestion Suggestion importance[1-10]: 8 Why: The broken image link would prevent users from seeing the example, significantly impacting documentation usability. The fix ensures proper visualization of auto best practices feature.	8
	Fix incorrect repository links Update repository links from 'qodo-ai/pr-agent' to 'Codium-ai/pr-agent' to maintain consistency with the actual repository location. docs/docs/core-abilities/auto_best_practices.md [17] -[`.pr_agent_accepted_suggestions`](https://github.com/qodo-ai/pr-agent/wiki/.pr_agent_accepted_suggestions) +[`.pr_agent_accepted_suggestions`](https://github.com/Codium-ai/pr-agent/wiki/.pr_agent_accepted_suggestions) Apply this suggestion Suggestion importance[1-10]: 8 Why: Incorrect repository links would lead users to non-existent resources. The fix ensures users can access the correct documentation and examples.	8

[mrT23]

/improve

[qodo-merge-pro-for-open-source]

PR Code Suggestions ✨

No code suggestions found for the PR.

[mrT23]

/help
Hi there,

I looked at the examples in your configuration, for instance this one for the reviewer prompt. They look great and detailed.

My question is: for Pro users, are /review, /describe, or /improve further optimized like the above or are the prompts simpler / in need for further tweaking?

Asked differently, what is the default prompt that pr-agent PRO uses for the tools and how good / detailed is it?

[qodo-merge-pro-for-open-source]

Question:

Hi there, I looked at the examples in your configuration, for instance this one for the reviewer prompt. They look great and detailed. My question is: for Pro users, are /review, /describe, or /improve further optimized like the above or are the prompts simpler / in need for further tweaking? Asked differently, what is the default prompt that pr-agent PRO uses for the tools and how good / detailed is it?

Answer:

Qodo Merge (PR-Agent Pro) uses the same detailed and optimized prompts as the open-source version for the core tools (/review, /describe, /improve). However, Qodo Merge provides additional benefits that enhance the effectiveness of these tools:

1. Model Selection: Qodo Merge uses a combination of Claude-3.5-sonnet and GPT-4 models by default, which are top-performing models for code analysis.

2. Enhanced Context: Qodo Merge implements advanced context handling through features like dynamic context extension and metadata injection, which helps the models better understand the code changes.

3. Auto Best Practices: Qodo Merge can learn from previously accepted suggestions to automatically generate and apply repository-specific best practices, making the suggestions more relevant over time.

So while the base prompts are the same, Qodo Merge enhances their effectiveness through better model selection, context handling, and learning capabilities.

Relevant Sources:

• https://qodo-merge-docs.qodo.ai//usage-guide/PR_agent_pro_models#qodo-merge-models
• https://qodo-merge-docs.qodo.ai//overview/pr_agent_pro#overview
• https://qodo-merge-docs.qodo.ai//core-abilities/auto_best_practices#auto-best-practices-💎