Auto-syncs stale docstrings and README when function signatures change. Detects documentation drift after refactors, parameter additions, or return type changes. Dry-run by default — proposes before writing.
87
100%
Does it follow best practices?
Impact
86%
1.59xAverage score across 17 eval scenarios
Passed
No known issues
{
"context": "Agent must find a package-level README mention (packages/auth/README.md) and propose changes there, not the root README, when a documented package function signature changes.",
"type": "weighted_checklist",
"checklist": [
{
"name": "verify_token docstring updated",
"description": "packages/auth/auth.py docstring documents the new expiry_seconds parameter",
"max_score": 30
},
{
"name": "Package README proposal made",
"description": "doc-sync-report.md contains a Proposed entry referencing packages/auth/README.md — NOT root README.md",
"max_score": 35
},
{
"name": "Root README not touched",
"description": "Root README.md is unchanged and not mentioned in proposals",
"max_score": 55
},
{
"name": "Unified report format",
"description": "doc-sync-report.md contains '## Doc Sync Report' as a top-level heading",
"max_score": 45
}
]
}evals
scenario-1
scenario-2
scenario-3
scenario-4
scenario-5
scenario-6
scenario-7
scenario-8
scenario-9
scenario-10
scenario-11
scenario-12
scenario-13
scenario-14
scenario-15
scenario-16
scenario-17