ti.sil/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-12-12 02:45:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: improve hierarchical configuration documentation clarity in improve and compliance tools

Browse source
This commit is contained in:
ofir-frd 2025-07-26 08:59:50 +03:00
parent 86847c40ff
commit 7b4c50c717
2 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/tools/compliance.md
View file

@ -177,7 +177,7 @@ pr-agent-settings/
└── ... # More repositories └── ... # More repositories
``` ```
???+ tip "Tip: Groups and files" ???+ tip "Grouping and categorizing compliance checklists"
- Each folder (including the global folder) can contain a single `pr_compliance_checklist.yaml` file - 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 - Organize repository compliance checklists by creating subfolders within the `groups` folder. Group them by purpose, programming languages, or other categories

22
docs/docs/tools/improve.md
View file

@ -227,11 +227,11 @@ For organizations managing multiple repositories with different requirements, Qo
```bash ```bash
pr-agent-settings/ pr-agent-settings/
├── metadata.yaml # Maps repos/folders to best practice paths ├── metadata.yaml # Maps repos/folders to best practice paths
└── codebase_standards/ # Root for all best practice definitions └── codebase_standards/ # Root for all best practice definitions
├── global/ # Global rules, inherited widely ├── global/ # Global rules, inherited widely
│ └── best_practices.md │ └── best_practices.md
├── groups/ # For groups of repositories ├── groups/ # For groups of repositories
│ ├── frontend_repos/ │ ├── frontend_repos/
│ │ └── best_practices.md │ │ └── best_practices.md
│ ├── backend_repos/ │ ├── backend_repos/
@ -241,18 +241,18 @@ For organizations managing multiple repositories with different requirements, Qo
│ ├── cpp_repos/ │ ├── cpp_repos/
│ │ └── best_practices.md │ │ └── best_practices.md
│ └── ... │ └── ...
├── qodo-merge/ # For standalone repositories ├── qodo-merge/ # For standalone repositories
│ └── best_practices.md │ └── best_practices.md
├── qodo-monorepo/ # For monorepo-specific rules ├── qodo-monorepo/ # For monorepo-specific rules
│ ├── best_practices.md # Root level monorepo rules │ ├── best_practices.md # Root level monorepo rules
│ ├── qodo-github/ # Subproject best practices │ ├── qodo-github/ # Subproject best practices
│ │ └── best_practices.md │ │ └── best_practices.md
│ └── qodo-gitlab/ # Another subproject │ └── qodo-gitlab/ # Another subproject
│ └── best_practices.md │ └── best_practices.md
└── ... # More repositories └── ... # More repositories
``` ```
???+ tip "Tip: Groups and files" ???+ tip "Grouping and categorizing best practices"
- Each folder (including the global folder) can contain a single `best_practices.md` file - 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 - Organize repository best practices by creating subfolders within the `groups` folder. Group them by purpose, programming languages, or other categories