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
A data team updated a TypeScript analytics function to return a richer result type. The function has a JSDoc comment. The README.md contains a reference table that lists exported functions and their descriptions. The team wants a documentation sync report.
The team wants a documentation sync report. Use --apply mode on the latest committed change.
Extract the following files, then set up the git repository:
=============== FILE: inputs/setup.sh =============== #!/usr/bin/env bash set -euo pipefail git init git config user.email "dev@example.com" git config user.name "Dev" mkdir -p src cat > src/analytics.ts << 'TSEOF' /**
| Function | Description |
|---|---|
| aggregateMetrics | Aggregates daily metrics over a date range. Returns a count. |
| MDEOF | |
| git add -A && git commit -m "baseline" | |
| cat > src/analytics.ts << 'TSEOF' | |
| export interface MetricsSummary { | |
| count: number; | |
| average: number; | |
| } |
/**
Sync the documentation and write the results to doc-sync-report.md.
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