| name | docs-sync |
| description | Quick check for docs that are out of sync with code |
Documentation Sync Check
Quick audit to catch common documentation drift issues.
Checks
1. Provider List Sync
grep -A 1 '@provider_type_mapping' lib/lasso/core/providers/adapter_registry.ex
grep -A 10 'Supported.*[Pp]roviders' README.md
Report if mismatch.
2. Broken File References
grep -roh 'lib/[^`"]*\.ex' project/ README.md | sort -u
for file in $(grep -roh 'lib/[^`"]*\.ex' project/ README.md | sort -u); do
[ -f "$file" ] || echo "Missing: $file"
done
Report broken paths.
3. Documentation TODOs
grep -rn "TODO\|FIXME\|WIP" project/ README.md
Report count and locations.
Output Format
DOCS SYNC CHECK
==================
Provider List:
README: [list]
Registry: [list]
[match status]
Broken References:
[results]
Documentation TODOs:
[count] found:
[locations]
QUICK FIXES:
- [actionable items]