write-clear-readme

To audit a README for clarity, the tool reads the repository content and evaluates wording concision, structural scannability, and anchor integrity. It then proposes explicit diffs for approval to restructure the document without breaking existing navigability.

Restructuring a monorepo README is best handled by applying grouped collapse strategies (Pattern A) or per-entry collapse strategies (Pattern B). These patterns organize dense content while validating anchors to maintain scannability and navigability for complex project documentation.

Fixing broken anchor links in a repository README requires validating anchor integrity during the audit phase. The tool checks collapsed sections for navigation consistency and proposes targeted diffs to repair anchors before applying any structural changes.

Yes, you can polish a CLI manual or npm SDK reference without losing existing anchors. The tool validates anchor integrity throughout the restructuring process and proposes diffs with explicit user approval to preserve all navigation links while improving wording concision.

No, the README polishing process does not apply changes automatically. It proposes and previews diffs requiring explicit user approval before any modifications are made, ensuring existing workflows and repository content remain preserved during structural reorganization.