docs: clarify OSS best practices configuration

[Ricky-7-Yan]

Summary

• clarify that automatic best_practices.md loading is a Qodo Merge feature
• document config.repo_context_files as the OSS configuration path
• describe the default branch, line-limit, and unsupported-provider behavior

Fixes #2377.

Validation

• git diff --check
• .venv\Scripts\python -m mkdocs build -f docs/mkdocs.yml

The documentation build completed successfully. It reported existing warnings about missing optional social-card imaging dependencies and existing unresolved documentation links.

[qodo-code-review]

PR Summary by Qodo

Clarify OSS best-practices configuration

📝 Documentation 🕐 Less than 10 minutes

AI Description

• Distinguishes Qodo Merge automatic best-practice loading from open-source PR-Agent behavior.
• Documents OSS repository-context configuration, branch selection, limits, and provider fallback
 behavior.

Diagram

graph TD
  A["Improve guide"] --> B{"Deployment type"} -->|Qodo Merge| C["Automatic loading"] --> F["AI suggestions"]
  B -->|Open source| D["Repository config"] --> E["Context fetch"] --> F

Loading

High-Level Assessment

The inline warning is the best approach because it corrects the misleading claim exactly where users encounter best-practices setup, while preserving the Qodo Merge instructions and providing the OSS equivalent. A separate OSS page would add navigation overhead for a small configuration distinction.

Files changed (1) +17 / -2

Documentation (1) +17 / -2

improve.mdDifferentiate OSS and Qodo Merge best-practices setup +17/-2

Differentiate OSS and Qodo Merge best-practices setup

• Adds an OSS warning with the repo_context_files configuration example and documents default-branch loading, the 500-line limit, target-branch selection, and unsupported-provider behavior. Renames the local best-practices heading to identify it as Qodo Merge-specific.

docs/docs/tools/improve.md

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📜 Skill insights (0)

1. Qodo Merge line exceeds limit ✓ Resolved 📘 Rule violation ⚙ Maintainability

Description

The newly added sentence is 156 characters long, exceeding the required 120-character maximum. This
makes the modified documentation source noncompliant with the repository-wide line-length rule.

Code

docs/docs/tools/improve.md[128]

+Qodo Merge supports both simple and hierarchical best practices configurations to provide guidance to the AI model for generating relevant code suggestions.

Relevance

●● Moderate

Recent line-length findings were rejected, but an equally close 120-character documentation wrap was
accepted; evidence is mixed.

PR-#2817
PR-#2774
PR-#2797

ⓘ Recommendations generated based on similar findings in past PRs

Evidence

PR Compliance ID 2694690 requires every line in modified non-generated source files to be no longer
than 120 characters; the added line at docs/docs/tools/improve.md[128-128] is 156 characters.

Rule 2694690: Enforce maximum line length of 120 characters
docs/docs/tools/improve.md[128-128]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The added `Qodo Merge` sentence is 156 characters long and exceeds the 120-character maximum.

## Issue Context
Wrap the Markdown paragraph without changing its meaning or rendered structure.

## Fix Focus Areas
- docs/docs/tools/improve.md[128-128]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

• Author self-review: I have reviewed the code review findings, and addressed the relevant ones.

Context sources

✅ Compliance rules (platform): 34 rules

Review mode: ⚖️ Balanced

Tip of the day

💡 Did you know, you can type 'qodo, fix this' on a finding and the fix lands right on your PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

[qodo-code-review]

Code review by qodo was updated up to the latest commit 0bea585

[IsmaelMartinez]

Thanks for this, and the content checks out against the code.

The last push mixed line endings though, 368 CRLF against 18 LF, so a change of 18 added and 2 removed now reads as 384 added and 368 removed. Could you restore LF throughout?

The wrap that came with it answers Qodo's 120-character flag, which is configured in Qodo rather than in this repo, so it will keep firing on docs. I would leave that line as it was: improve.md already carries untouched lines of 472, 461 and 402 characters.

One content point. The block sits under the Platforms supported: GitHub, GitLab, Bitbucket banner at line 111, but repo_context_files also works on Gitea and Azure DevOps. additional_configurations.md:268 has the full list.

[qodo-code-review]

Code Review by Qodo

Sorry, something went wrong

We weren't able to complete the code review on our side. Please try again manually by commenting /agentic_review on this PR.

[Ricky-7-Yan]

Addressed in 57a14b7. The file is now normalized to LF throughout, the Qodo Merge sentence is back on its original single line, and the OSS fallback explicitly lists GitHub, GitLab, Gitea, Bitbucket, and Azure DevOps. The cumulative PR diff is back to one file with 18 additions and 2 deletions, and git diff --check passes. Thanks for the precise review.

[IsmaelMartinez]

Perfect, thank you for turning that round so quickly. Taking it from here, and thanks again for contributing.