docs: update configuration options and improve wiki documentation cla…

[hussam789]

User description

…rity

---

PR Type

Documentation

---

Description

• Updated references to best_practices.md for clarity.

• Removed emphasis on using wiki for best practices.

• Added guidance on global best practices configuration.

• Improved clarity in configuration and enabling wiki documentation.

---

Changes walkthrough 📝

Relevant files

Documentation

improve.md Clarified usage of `best_practices.md` in documentation    docs/docs/tools/improve.md Updated references to best_practices.md for clarity. Removed recommendation to use wiki for best practices. Clarified global and local best practices configuration. +5/-5      configuration_options.md Added guidance on global best practices configuration        docs/docs/usage-guide/configuration_options.md Added note on optional global best practices file. Improved clarity on configuration file structure. +2/-1      enabling_a_wiki.md Refined documentation on enabling and using wikis                docs/docs/usage-guide/enabling_a_wiki.md Removed reference to best_practices.md in wiki features. Improved clarity on wiki advantages and usage. +1/-2

---

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-free-for-open-source-projects]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Inconsistent Guidance The document now recommends using a local best_practices.md file in the repository root, but doesn't clearly explain the transition from the previous wiki-based approach. Users might be confused about whether existing wiki-based best practices files need migration. Another option to give additional guidance to the AI model is by creating a `best_practices.md` file in your repository's root directory. This page can contain a list of best practices, coding standards, and guidelines that are specific to your repo/organization. The AI model will use this `best_practices.md` file as a reference, and in case the PR code violates any of the guidelines, it will create additional suggestions, with a dedicated label: `Organization best practice`. Incomplete Reference The added line mentions a "global best practices file" with a link to the global configuration file section, but that section doesn't specifically address best practices files. This could create confusion for users trying to follow the documentation. 4. Optionally, you can add organizational-level [global best practices file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file).

[qodo-free-for-open-source-projects]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Fix incorrect documentation link The link for global best practices points to the global configuration file section, which doesn't contain specific information about best practices files. Link to the appropriate section that explains global best practices in detail. docs/docs/usage-guide/configuration_options.md [91] -4. Optionally, you can add organizational-level [global best practices file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file). +4. Optionally, you can add organizational-level [global best practices file](https://qodo-merge-docs.qodo.ai/tools/improve/#local-and-global-best-practices). Apply this suggestion Suggestion importance[1-10]: 8 __ Why: The suggestion correctly identifies that the link for global best practices points to an incorrect section. Updating it to point to the specific section about local and global best practices significantly improves documentation accuracy and user navigation.	Medium
	Fix circular documentation reference The link to the global configuration file documentation points to the same section as the text itself, creating a circular reference. Consider linking to a more specific section about best practices or removing the link if redundant. docs/docs/tools/improve.md [161] -Then, create a `best_practices.md` file in the root of [global](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) configuration repository, `pr-agent-settings`. +Then, create a `best_practices.md` file in the root of the global configuration repository, `pr-agent-settings`. Apply this suggestion Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies a circular reference in the documentation where the link points to the same section as the text itself. Removing this redundant link improves documentation clarity and prevents user confusion.	Medium
More

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