Build workspace docs
Skill MoizIbnYousaf/Ai-Agent-Skills/skills/build-workspace-docs
Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.From its SKILL.md
npx -y skills add MoizIbnYousaf/Ai-Agent-Skills --skill build-workspace-docsAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- runs commandsInstructs the agent to run 3 commands, including `npx ai-agent-skills build-docs --dry-run` and 2 more.
SKILL.md
1.5 KB, 309 tokens by cl100k_base, as published. Nobody here has run it
Build Workspace Docs
Goal
Keep workspace documentation in sync with the skills catalog after adding, removing, or curating skills.
Guardrails
- Always use
--dry-runbefore 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 jsonto capture structured results for automation pipelines.
Workflow
- Preview what would change.
npx ai-agent-skills build-docs --dry-run
- Regenerate the docs.
npx ai-agent-skills build-docs
- 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, orcuratecommands 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-libraryto create one first. - The generated docs use HTML comment markers (
<!-- GENERATED:...:start/end -->) as boundaries. Do not remove these markers from the template sections.
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.