build-workspace-docs
build-workspace-docs regenerates README.md and WORK_AREAS.md files to reflect the current skills catalog in a managed library workspace. Use this skill after adding, removing, or curating skills, and always run with the --dry-run flag first to preview changes before applying them to the workspace documentation.
git clone --depth 1 https://github.com/MoizIbnYousaf/Ai-Agent-Skills /tmp/build-workspace-docs && cp -r /tmp/build-workspace-docs/skills/build-workspace-docs ~/.claude/skills/build-workspace-docsSKILL.md
# Build Workspace Docs ## Goal Keep workspace documentation in sync with the skills catalog after adding, removing, or curating skills. ## Guardrails - Always use `--dry-run` before regenerating docs to preview what will change. - Only run from inside an initialized library workspace (a directory with `.ai-agent-skills/config.json`). - Never hand-edit the generated sections of README.md or WORK_AREAS.md. The CLI will overwrite them. - Use `--format json` to capture structured results for automation pipelines. ## Workflow 1. Preview what would change. ```bash npx ai-agent-skills build-docs --dry-run ``` 2. Regenerate the docs. ```bash npx ai-agent-skills build-docs ``` 3. Verify the output. ```bash npx ai-agent-skills build-docs --dry-run --format json ``` The JSON output includes `currentlyInSync` to tell you whether docs were already up to date. ## When to Run - After `add`, `catalog`, `vendor`, or `curate` commands that change the skills catalog. - After bulk imports from a remote library. - Before committing workspace changes to git. ## Gotchas - Running outside a workspace will fail with a clear error. Use `init-library` to create one first. - The generated docs use HTML comment markers (`<!-- GENERATED:...:start/end -->`) as boundaries. Do not remove these markers from the template sections.
Clarify requirements before implementing. Do not use automatically, only when invoked explicitly.
Use when checking the overall health of a skills library. Run doctor, validate, check for stale skills, and verify generated docs are in sync.
Backend API design, database architecture, microservices patterns, and test-driven development. Use for designing APIs, database schemas, or backend system architecture.
>-
Use when exploring the ai-agent-skills catalog to find, compare, and evaluate skills before installing. Always use --fields to limit output size and --dry-run before committing to an install.
Automatically creates user-facing changelogs from git commits by analyzing commit history, categorizing changes, and transforming technical commits into clear, customer-friendly release notes. Turns hours of manual changelog writing into minutes of automated generation.
Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.