auto-doc

To automatically update README and CHANGELOG from git diff, this Skill analyzes workspace changes to extract code and API modifications, then synchronizes documentation entries without manual intervention. It identifies non-documentation code changes and appends concise records to the appropriate markdown files.

Auto-generating a changelog from code changes maintains markdown syntax integrity by strictly following Keep a Changelog conventions. The Skill appends precise entries to the Unreleased section and ensures the existing markdown structure remains valid while suggesting semantic version adjustments.

You need to synchronize README examples before a release when configuration items or external APIs have been modified. During commit staging or pre-release preparation, the Skill detects these specific changes and updates the affected configuration descriptions and usage examples.

Yes, you can use semantic versioning recommendations without manually checking git diffs. The Skill analyzes extracted code modifications and automatically recommends SemVer version changes based on the significance of the added features or fixes it detects in your workspace.

A key limitation of automatically extracting code modifications for documentation is that the Skill avoids inventing changes. It only records verified modifications from the git diff, ensuring documentation accuracy but requiring actual staged code changes to generate meaningful README and CHANGELOG updates.