---
name: Build Workspace Docs
slug: build-workspace-docs
category: Writing
description: Build Workspace Docs regenerates README.md and WORK_AREAS.md in a managed AI agent skills library workspace. Use it after adding, cataloging, or curating skills to keep workspace documentation in sync with the skills catalog.
github: "https://github.com/MoizIbnYousaf/Ai-Agent-Skills/tree/main/skills/build-workspace-docs"
language: JavaScript
stars: 1124
forks: 131
install: "npx degit https://github.com/MoizIbnYousaf/Ai-Agent-Skills/tree/main/skills/build-workspace-docs ~/.claude/skills/build-workspace-docs"
installs_to: ~/.claude/skills/build-workspace-docs
source_path: skills/build-workspace-docs/SKILL.md
collection_size: 18
category_size: 1012
collection_url: "https://dirskills.com/collections/MoizIbnYousaf/Ai-Agent-Skills"
added: 2026-08-20T07:56:24.667Z
last_synced: 2026-08-20T07:56:24.667Z
canonical_url: "https://dirskills.com/skills/build-workspace-docs"
---

# Build Workspace Docs

Build Workspace Docs regenerates README.md and WORK_AREAS.md in a managed AI agent skills library workspace. Use it after adding, cataloging, or curating skills to keep workspace documentation in sync with the skills catalog.

**Install:**

```bash
npx degit https://github.com/MoizIbnYousaf/Ai-Agent-Skills/tree/main/skills/build-workspace-docs ~/.claude/skills/build-workspace-docs
```

## README

# 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.