diff --git a/docs/docs/tools/compliance.md b/docs/docs/tools/compliance.md index c65069a8..beb3aa47 100644 --- a/docs/docs/tools/compliance.md +++ b/docs/docs/tools/compliance.md @@ -177,6 +177,10 @@ pr-agent-settings/ └── ... # More repositories ``` +???+ tip "Tip: Groups and files" + - Each folder (including the global folder) can contain a single `pr_compliance_checklist.yaml` file + - Organize repository compliance checklists by creating subfolders within the `groups` folder. Group them by purpose, programming languages, or other categories + 3\. Define the metadata file `metadata.yaml` in the root of `pr-agent-settings`: ```yaml diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index 6ef2cb28..e2e3c0a3 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -156,6 +156,7 @@ Qodo Merge supports both simple and hierarchical best practices configurations t - Keep each file relatively short, under 800 lines, since: - AI models may not process effectively very long documents - Long files tend to contain generic guidelines already known to AI + - Maximum multiple file accumulated content is limited to 2000 lines. - Use pattern-based structure rather than simple bullet points for better clarity ???- tip "Example of a best practices file" @@ -251,6 +252,10 @@ For organizations managing multiple repositories with different requirements, Qo └── ... # More repositories ``` +???+ tip "Tip: Groups and files" + - Each folder (including the global folder) can contain a single `best_practices.md` file + - Organize repository best practices by creating subfolders within the `groups` folder. Group them by purpose, programming languages, or other categories + 3\. Define the metadata file `metadata.yaml` that maps your repositories to their relevant best practices paths, for example: ```yaml