readme-sync

Cleaning up AI-generated markdown files involves identifying artifacts like planning documents and summaries, extracting their useful information into README.md, and then deleting them. This process distinguishes AI content from human-authored docs to preserve original files.

You can consolidate AI planning documents into README.md without losing human-authored documentation. The process inventories and classifies markdown files, absorbing AI-generated content into README.md while explicitly preserving human-authored documentation.

The best way to remove temporary AI coding session artifacts is to use an automated tool that identifies AI-generated summaries and plans, merges their useful insights into README.md, and then deletes the artifacts. This prevents manual cleanup errors and lost information.

Yes, readme-sync works with standard markdown files like PLAN.md and ANALYSIS.md. It identifies these AI-generated artifacts from previous coding sessions, extracts their relevant content, and integrates it into the main README.md before removing them.

Merging AI analysis summaries into main project documentation requires reading and classifying the markdown files, extracting valuable information, and editing README.md to absorb it. The temporary analysis files are then deleted from the repository.

The limitations of automatically consolidating markdown content into README.md include the dependency on glob, read, bash, write, and edit tools to function. It also relies on accurately classifying AI artifacts versus human-authored files to avoid unintended data loss.