Document every configuration setting

[smar-ian-phillips]

Feature request

Document every configuration setting in https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml/

Simply having an explanatory comment above each one would suffice.

Motivation

The documentation at https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/ directs us to the configuration.toml source file, but since most of the settings are not documented, that's of limited value.

[qodo-merge-for-open-source]

💡 Auto-generated documentation-based answer:

This is a valid feature request. While the documentation does provide information about configuration options, it doesn't comprehensively document every setting available in the configuration.toml file.

Current Documentation Status

The documentation currently covers:

1. General configuration approach - How to use configuration files (wiki, local, global)
2. Tool-specific configurations - Many tools have dedicated configuration sections in their respective documentation pages
3. Common configuration patterns - Examples for different use cases

What's Available Now

You can view available configurations in several ways:

1. Use the /config command - Comment /config on any PR to see all available configuration options
2. Tool-specific documentation - Each tool page (like /review, /improve, /describe) includes its relevant configuration options
3. Configuration examples - The documentation includes many practical examples of configuration usage

The Gap

You're correct that the main configuration.toml file itself lacks comprehensive inline documentation. The current approach requires users to:

• Cross-reference between the source file and documentation
• Use the /config command to discover options
• Refer to individual tool documentation pages

Recommendation

Your suggestion to add explanatory comments above each configuration setting in the source file would indeed improve the developer experience. This would make the configuration.toml file self-documenting and reduce the need to cross-reference multiple sources.

This appears to be a legitimate enhancement request that would benefit the project's usability.

Relevant Sources:

• https://qodo-merge-docs.qodo.ai//usage-guide/configuration_options
• https://qodo-merge-docs.qodo.ai//usage-guide/additional_configurations#show-possible-configurations
• https://qodo-merge-docs.qodo.ai//tools/review#configuration-options
• https://qodo-merge-docs.qodo.ai//tools/improve#configuration-options