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 Node.js SDK team has just added a new exported function to their auth module. The function was shipped with a JSDoc comment because the developer wrote docs as part of the PR. The team's README.md has an API Reference section that lists exported functions, and they want the docs to stay in sync.
Update the documentation for the latest committed change. Since this is part of the release process, use --apply mode.
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/auth.ts << 'TSEOF' /**
Utilities for handling authentication in the SDK.
validateToken(token) — Validates a bearer token and returns the user ID.
MDEOF
git add -A && git commit -m "baseline"
cat > src/auth.ts << 'TSEOF'
/**/**
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