Agent skill · Documentation

build-workspace-docs

Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.

MoizIbnYousafgithub.com/MoizIbnYousafGitHub ↗
claude-codecodexcursorMIT
Install
npx skills add MoizIbnYousaf/Ai-Agent-Skills --skill build-workspace-docs --agent claude-code

Same command for any agent — swap --agent for codex, cursor, copilot.

Facts
Files in the skill folder: 1
SKILL.md size: 2 KB
Bundled scripts: none
Version: 4.1.0
Path: skills/build-workspace-docs/SKILL.md
Open the folder on GitHub →
Where it comes from
Stars: 1,114
Language: JavaScript

Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.

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 commen

What's inside
Steps it walks through
  1. Goal
  2. Guardrails
  3. Workflow
  4. When to Run
  5. Gotchas
Commands it runs
npx ai-agent-skills build-docs --dry-run
npx ai-agent-skills build-docs
npx ai-agent-skills build-docs --dry-run --format json
More from Ai-Agent-Skills
All skills →
About this skill
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 it?

Run `npx skills add MoizIbnYousaf/Ai-Agent-Skills --skill build-workspace-docs --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.

Where does this skill come from?

From MoizIbnYousaf/Ai-Agent-Skills, a repository with 1,114 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.

Is a popular skill a good skill?

Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.

Keep going