diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index 85d9bbe0..b88bca79 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -67,6 +67,31 @@ In post-process, Qodo Merge counts the number of suggestions that were implement {width=512} +## Suggestion tracking 💎 +`Platforms supported: GitHub, GitLab` + +Qodo Merge employs an innovative detection system to automatically [identify](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) code suggestions that PR authors have accepted and implemented. + +Accepted suggestions are also automatically documented in a dedicated wiki page called `.pr_agent_accepted_suggestions`, allowing users to track historical changes, assess the tool's effectiveness, and learn from previously implemented recommendations in the repository. +An example [result](https://github.com/Codium-ai/pr-agent/wiki/.pr_agent_accepted_suggestions): + +[{width=768}](https://github.com/Codium-ai/pr-agent/wiki/.pr_agent_accepted_suggestions) + +This dedicated wiki page will also serve as a foundation for future AI model improvements, allowing it to learn from historically implemented suggestions and generate more targeted, contextually relevant recommendations. + +This feature is controlled by a boolean configuration parameter: `pr_code_suggestions.wiki_page_accepted_suggestions` (default is true). + +!!! note "Wiki must be enabled" + While the aggregation process is automatic, GitHub repositories require a one-time manual wiki setup. + + To initialize the wiki: navigate to `Wiki`, select `Create the first page`, then click `Save page`. + + {width=768} + + Once a wiki repo is created, the tool will automatically use this wiki for tracking suggestions. + + + ## Usage Tips @@ -272,6 +297,10 @@ Using a combination of both can help the AI model to provide relevant and tailor