Skip to content
alyn
MoizIbnYousaf

Build Workspace Docs skill

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

$npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs
View this skill on GitHubMoizIbnYousaf/ai-agent-skills/skills/build-workspace-docs/SKILL.md
Pack stars
1,156
Pack installs
13k
Alyn Score
52/99
Updated
2 months ago
License
MIT
– views – installs via Alyn

MoizIbnYousaf

Build Workspace Docs

Coding

Install Build Workspace Docs

Pick your agent. Every command is ready to paste.

$npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs

The open skills CLI detects your agents (Claude Code, Cursor, Codex and 70+ more) and installs to the right folder. Add -g to install globally.

01

Install it

Run the command above, or upload the folder in Claude.

02

Ask naturally

Describe the task. Your agent loads build-workspace-docs when the request matches its description.

03

Name it if needed

If it does not trigger, say “use the build-workspace-docs skill”. In Codex, type $build-workspace-docs.

The skill itself

SKILL.md

FolderGitHub

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.
npx ai-agent-skills build-docs --dry-run
  1. Regenerate the docs.
npx ai-agent-skills build-docs
  1. Verify the output.
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.

Tips for Build Workspace Docs

  • • Start a fresh session after installing so your agent picks up the new skill.
  • • It is part of a pack with 18 skills. Install only the ones you need with --skill to keep triggers precise.
  • • If two skills overlap, mention the one you want by name.

Questions about Build Workspace Docs

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 Build Workspace Docs?

Run "npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs" in your project. The skills CLI installs it for Claude Code, Cursor, Codex and 70+ other agents. In Claude on the web, upload the skill folder as a ZIP under Customize > Skills.

Does Build Workspace Docs work in Cursor and Codex?

Yes. Build Workspace Docs uses the open SKILL.md format, so it works in Claude Code, Claude, Cursor, OpenAI Codex, Gemini CLI, GitHub Copilot and other agents that support agent skills.

Is Build Workspace Docs free?

Build Workspace Docs is open source on GitHub under the MIT license. It is free to install; check the license before commercial use.

Who made Build Workspace Docs?

Build Workspace Docs is published by MoizIbnYousaf in the MoizIbnYousaf/ai-agent-skills repository, together with 17 other skills.

Similar skills. From other creators.