skills.rest
skillcreatorai
skillcreatoraiCOMMUNITY
Explore all skills by this author →
Website𝕏@skillcreatoraiGitHub

build-workspace-docs

Regenerates README.md and WORK_AREAS.md documentation for a managed skills library workspace.

1.1k|131|Updated Dec 17, 2025
Search Tags:#CLI#workspace#Markdown#Documentation#dry-run#skills catalog#ReadMe
One-click install
npx skills add https://github.com/skillcreatorai/Ai-Agent-Skills --skill build-workspace-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: build-workspace-docs
Source: https://github.com/skillcreatorai/Ai-Agent-Skills/tree/main/skills/build-workspace-docs
Command: npx skills add https://github.com/skillcreatorai/Ai-Agent-Skills --skill build-workspace-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires ai-agent-skills.

What problem does it solve?

After adding, removing, or curating skills in a managed library workspace, the workspace documentation (README.md and WORK_AREAS.md) drifts out of sync with the actual skills catalog. This Skill regenerates those docs from the catalog so they always reflect the current state, with a dry-run preview to prevent unwanted changes.

Core Features & Use Cases

  • Dry-Run Preview: Run npx ai-agent-skills build-docs --dry-run to see exactly what will change before writing anything.
  • Catalog-Driven Regeneration: Rebuilds the generated sections of README.md and WORK_AREAS.md from the current skills catalog after add, catalog, vendor, or curate operations.
  • Structured JSON Output: Use --format json to capture results for automation pipelines, including a currentlyInSync flag.
  • Use Case: After bulk-importing skills from a remote library, run the dry-run to preview doc changes, regenerate the docs, then verify sync status before committing the workspace to git.

Quick Start

Run a dry-run of the docs build inside my initialized library workspace, then regenerate README.md and WORK_AREAS.md and confirm they are in sync.

Frequently Asked Questions about build-workspace-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I regenerate README.md for my ai-agent-skills workspace?▼

Run `npx ai-agent-skills build-docs` from inside an initialized library workspace. Preview changes first with `npx ai-agent-skills build-docs --dry-run` so you can see exactly what will be modified before writing.

How do I preview documentation changes before regenerating?▼

Use the `--dry-run` flag with the build-docs command to preview all changes without writing files. Add `--format json` to get structured output, including a `currentlyInSync` field indicating whether docs are already up to date.

When should I run build-docs in a skills library?▼

Run it after any command that changes the skills catalog, such as `add`, `catalog`, `vendor`, or `curate`, and after bulk imports from a remote library. It is also recommended before committing workspace changes to git.

Why does build-docs fail with a workspace error?▼

The command only runs inside an initialized library workspace containing a `.ai-agent-skills/config.json` file. If you run it elsewhere it fails with a clear error; use the `init-library` command to create a workspace first.

Can I manually edit the generated sections of README.md?▼

No. Generated sections are delimited by HTML comment markers like `<!-- GENERATED:...:start/end -->` and will be overwritten by the CLI. Do not remove these markers or hand-edit content between them.

Related Skills

Explore More Software Engineering Skills→
zyj18860969891-bytezyj18860969891-byte

skill-database-manager

Manage OpenClaw skill catalog records with PostgreSQL-backed scripts.

Community
Advanced
swarm-ai-researchswarm-ai-research

RSS Feed Generator

Generate and validate an Atom feed from Markdown articles.

Official
Advanced
saxonthunesaxonthune
1

carta-cli

Perform deterministic structural edits on .carta workspaces while rewriting docXX.YY references and rebuilding MANIFEST.md.

Community
Advanced
ichuanichuan
1

roadmap-management

Create and maintain a position-based ROADMAP.md with priority ordering and Doing limits.

Community
Basic