Skip to content

feat: enhance documentation with additional repository metadata secti…#2021

Merged
mrT23 merged 2 commits into
mainfrom
tr/docs
Sep 2, 2025
Merged

feat: enhance documentation with additional repository metadata secti…#2021
mrT23 merged 2 commits into
mainfrom
tr/docs

Conversation

@mrT23
Copy link
Copy Markdown
Contributor

@mrT23 mrT23 commented Sep 2, 2025

User description

…on and update model references


PR Type

Enhancement, Documentation


Description

  • Add repository metadata configuration for enhanced context

  • Update model references to include latest supported models

  • Remove deprecated patch extra lines documentation

  • Clean up navigation and documentation structure


Diagram Walkthrough

flowchart LR
  A["Configuration"] --> B["Repository Metadata"]
  A --> C["Model Updates"]
  D["Documentation"] --> E["Remove Deprecated"]
  D --> F["Update Navigation"]
Loading

File Walkthrough

Relevant files
Documentation
additional_configurations.md
Add repository metadata configuration documentation           

docs/docs/usage-guide/additional_configurations.md

  • Remove deprecated "Patch Extra Lines" section
  • Add new "Bringing additional repository metadata" section
  • Document add_repo_metadata configuration option
  • Include examples for custom metadata file lists
+21/-27 
changing_a_model.md
Update model reference description                                             

docs/docs/usage-guide/changing_a_model.md

  • Update model reference description for clarity
  • Change from "available models" to "supported models"
+1/-1     
index.md
Remove deprecated navigation item                                               

docs/docs/usage-guide/index.md

  • Remove "Patch Extra Lines" from navigation menu
+0/-1     
qodo_merge_models.md
Update default model list                                                               

docs/docs/usage-guide/qodo_merge_models.md

  • Update default models to include Sonnet-4
  • Add diamond emoji to title
+1/-1     
Configuration changes
mkdocs.yml
Clean up navigation formatting                                                     

docs/mkdocs.yml

  • Remove diamond emoji from "Qodo Merge Models" navigation
+1/-1     
configuration.toml
Add repository metadata configuration options                       

pr_agent/settings/configuration.toml

  • Add add_repo_metadata configuration option
  • Add add_repo_metadata_file_list with default metadata files
  • Include diamond emoji in comments
+3/-0     

@qodo-free-for-open-source-projects
Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
✅ No TODO sections
🔒 No security concerns identified
⚡ Recommended focus areas for review

Naming Consistency

The new config keys add_repo_metadata and add_repo_metadata_file_list must match any code that reads them; verify that the codebase uses these exact names and expected types (bool/list of strings).

# bring repo metadata 💎
add_repo_metadata=false # if true, will try to add metadata from files like 'AGENT.MD', 'CLAUDE.MD', 'QODO.MD' etc.
add_repo_metadata_file_list =["AGENT.MD", "CLAUDE.MD", "QODO.MD"]
Docs Consistency

Documentation shows add_repo_metadata = true and a file list; ensure behavior, defaults, and file names align with configuration defaults and actual implementation, including case sensitivity of filenames.

## Bringing additional repository metadata to Qodo Merge 💎

To provide Qodo Merge with additional context about your project, you can enable automatic repository metadata detection. 

If you set

```toml
[config]
add_repo_metadata = true

Qodo Merge will attempt to fetch repository metadata from the root directory of your PR's head branch, looking for common metadata files such as:
AGENT.MD, QODO.MD, CLAUDE.MD, etc.

You can also specify custom filenames to search for:

[config]
add_repo_metadata_file_list= ["file1.md", "file2.md", ...]

</details>

</td></tr>
</table>

@qodo-free-for-open-source-projects
Copy link
Copy Markdown
Contributor

qodo-free-for-open-source-projects Bot commented Sep 2, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
High-level
Align model defaults across docs

The docs conflict on model defaults—“Changing a model” cites o4-mini as default
while “Qodo Merge Models” claims GPT-5/Sonnet-4/Gemini 2.5 Pro are default. This
inconsistency will confuse users and may not reflect what the code actually
supports; use a single, verified source of truth (from code/config) and update
all pages to the same defaults and supported models list. Also ensure the
“supported models” link and examples match the current implementation and
release gates.

Examples:

docs/docs/usage-guide/changing_a_model.md [4]
To use a different model than the default (o4-mini), you need to edit in the [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L2) the fields:
docs/docs/usage-guide/qodo_merge_models.md [2]
The default models used by Qodo Merge 💎 (August 2025) are a combination of GPT-5, Sonnet-4, and Gemini 2.5 Pro.

Solution Walkthrough:

Before:

// In 'docs/docs/usage-guide/changing_a_model.md'
To use a different model than the default (o4-mini),
you need to edit in the configuration file...

// In 'docs/docs/usage-guide/qodo_merge_models.md'
The default models used by Qodo Merge ... are a combination of
GPT-5, Sonnet-4, and Gemini 2.5 Pro.

After:

// In 'docs/docs/usage-guide/changing_a_model.md'
To use a different model than the default ([Correct Default Model]),
you need to edit in the configuration file...

// In 'docs/docs/usage-guide/qodo_merge_models.md'
The default models used by Qodo Merge ... are a combination of
[Correct Default Model List].

// Note: Both files now reflect the same, correct default model information.
Suggestion importance[1-10]: 9

__

Why: The suggestion correctly identifies a significant contradiction in the documentation regarding the default model, which the PR failed to resolve despite editing the relevant files.

High
Possible issue
Fix invalid TOML example

Replace the "..." placeholder with a valid TOML example to prevent copy-paste
parse errors. Use a concrete list and, if needed, a trailing comment to indicate
extensibility.

docs/docs/usage-guide/additional_configurations.md [152]

-add_repo_metadata_file_list= ["file1.md", "file2.md", ...]
+add_repo_metadata_file_list = ["file1.md", "file2.md"] # add more files as needed
  • Apply / Chat
Suggestion importance[1-10]: 5

__

Why: The suggestion correctly identifies that ... is invalid TOML syntax in an example code block and proposes a valid alternative that uses a comment to indicate extensibility, improving documentation clarity.

Low
General
Remove emoji from config comment

Remove the emoji from the comment to avoid potential encoding issues in
environments reading config files as ASCII. Keep comments strictly ASCII for
maximum compatibility across tooling.

pr_agent/settings/configuration.toml [52]

-# bring repo metadata 💎
+# bring repo metadata
  • Apply / Chat
Suggestion importance[1-10]: 3

__

Why: The suggestion correctly points out that non-ASCII characters in configuration files can cause issues in some environments. While the risk is low, adhering to ASCII for comments is a good practice for maximum compatibility.

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

@mrT23 mrT23 merged commit 532fbbe into main Sep 2, 2025
2 checks passed
@mrT23 mrT23 deleted the tr/docs branch September 2, 2025 05:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant