Build Workspace Docs
Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.
Install
npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docsgit clone --depth 1 https://github.com/MoizIbnYousaf/ai-agent-skills.git /tmp/ai-agent-skills
mkdir -p ~/.claude/skills
cp -r /tmp/ai-agent-skills/skills/build-workspace-docs ~/.claude/skills/build-workspace-docsPersonal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.
From the SKILL.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 (``) as boundaries. Do not remove these markers from the template sections.
Details
- Skill name
build-workspace-docs- Repository
- MoizIbnYousaf/ai-agent-skills
- Path
skills/build-workspace-docs/SKILL.md- License
- MIT
- Repo updated
- 21 September 2026
- Listed in
- heilcheng/awesome-agent-skills
FAQ
What does the Build Workspace Docs skill do?
Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.
How do I install the Build Workspace Docs skill?
skills CLI (Claude Code, Cursor, Codex and more): npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.
Is Build Workspace Docs popular?
It lives in MoizIbnYousaf/ai-agent-skills, which has 1,160 GitHub stars and 137 forks, and is included in 1 curated skill list.
Related skills
Content Research Writer
1.2kMoizIbnYousaf/ai-agent-skills
Conducts research, adds citations, and improves writing quality. Research topics thoroughly and produce well-cited content.
Changelog Generator
1.2kMoizIbnYousaf/ai-agent-skills
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.
Ask Questions If Underspecified
1.2kMoizIbnYousaf/ai-agent-skills
Clarify requirements before implementing. Do not use automatically, only when invoked explicitly.
Code Documentation
1.2kMoizIbnYousaf/ai-agent-skills
Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.
Cqrs Implementation
2krmyndharis/antigravity-skills
Implement Command Query Responsibility Segregation for scalable architectures. Use when separating read and write models, optimizing query performance, or building event-sourced systems.
Review a Skill
1.2kMoizIbnYousaf/ai-agent-skills
Use when evaluating whether a skill belongs in a library. Preview content, check frontmatter, validate structure, and decide whether to keep, curate, or remove.
Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.