Automate documentation mirror creation and synchronization with a codebase.
npx skills add https://github.com/sancovp/doc-mirror --skill doc-mirror
Please help me install this Agent Skill. Skill: doc-mirror Source: https://github.com/sancovp/doc-mirror/tree/main/skills/doc-mirror Command: npx skills add https://github.com/sancovp/doc-mirror --skill doc-mirror
This Skill automates the creation and maintenance of a 1:1 documentation mirror for a codebase, ensuring documentation stays in sync with code changes and never drifts.
Initialize the documentation mirror for your codebase using the 'doc-mirror-init' skill.
High-intent search queries and answers about installing and using this skill.
Documentation mirroring is automated by generating and synchronizing files to match the codebase structure. This prevents documentation drift by maintaining a 1:1 mirror as code changes occur.
A state machine workflow manages codebase development by progressing through predefined states for initialization, code changes, and vision management. It ensures structured and consistent project evolution.
Python is required to execute the scripts that run the state machine and maintain documentation synchronization. You must have a Python environment configured to utilize this automation.
Keeping documentation in sync with complex codebases is best handled by automated mirroring. It updates documentation files automatically during codebase initialization and changes to prevent drift.
To initialize a documentation mirror, run the initialization command to set up the state machine. This creates the baseline 1:1 documentation structure reflecting your current codebase.
freire19Create audit documentation and map codebase structure for pre-audit context.
nesihaver-ILUpdate README, API, architecture docs, and changelogs after code changes.
probationer070Automate post-merge project documentation updates after code shipments.
channgGenerate static documentation websites from markdown files with sidebar navigation.
