Documentation Generator

Restructure and organize project documentation for clarity and accessibility.

Prerequisites

This skill requires (validate each before starting; if any check fails, stop and ask the user):

Git working tree: clean or stashable. Run git status first; if dirty, back up via git stash push -u -m "pre-docs-sync" before any sync that could rebase or overwrite local changes.
Tools required: git >= 2.30, a Markdown-aware editor, and mermaid-cli (or a renderer) only if diagrams must be exported. Confirm availability with git --version and command -v mmdc.
Repo permissions: read access for analysis; write access only when the user explicitly approves commits. For read-only repos, fall back to emitting a diff or inline summary instead of writing files.
Branch state: an origin remote that is reachable (git remote get-url origin); if missing, do not attempt rebase/pull — ask the user.
Backups: confirm the repo is pushed or otherwise backed up before any restructure that deletes or moves doc files. Pair every destructive rm/git mv with a prior git status check and explicit user confirmation; never run git reset --hard, git push --force, or rm -rf without a dry-run preview and user approval.
Safety defaults: prefer dry-run previews (git mv -n, rm -i) and require user confirmation before any irreversible action.

If any prerequisite fails, halt and surface the blocker to the user rather than proceeding.

Before creating/updating/deleting files in an existing repository, sync the current branch with remote: