What problem does it solve?
After running a doc alignment audit, you are left with a list of recommended fixes for outdated content, incorrect references, and contradictory information across your documentation files. Manually applying each of these fixes is tedious, error-prone, and takes time away from higher-priority work.
Core Features & Use Cases
- Automated Fix Application: Parses doc-alignment reports (default
doc-alignment-report.md) to extract patch queues and contradiction fixes, then applies them directly to the target doc files.
- Safe, Scoped Edits: Only modifies non-executable documentation files (Markdown, plain text, inline doc comments in non-code configs) and never touches source code, build configs, or runtime manifests.
- Validation & Error Handling: Checks for conflicting patches, skips already resolved fixes, and flags unresolvable changes that require human input to avoid incorrect edits.
- Use Case: For example, after auditing your project's README and CONTRIBUTING files for outdated dependency paths and incorrect setup instructions, use this skill to automatically apply all recommended fixes without manually editing each file.
Quick Start
Use the act-on-doc-alignment skill to apply all fixes from the doc-alignment-report.md file in your current repository to the relevant documentation files.