build-workspace-docs
Use when regenerating README.md and WORKAREAS.md in a managed library workspace. Always dry-run first to preview changes.
- Installs
- 169
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/moizibnyousaf/ai-agent-skills --skill build-workspace-docs- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads build-workspace-docs automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
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.
FAQ
What does the build-workspace-docs skill do?
Use when regenerating README.md and WORKAREAS.md in a managed library workspace. Always dry-run first to preview changes.
How do I install build-workspace-docs?
Run npx skills add https://github.com/moizibnyousaf/ai-agent-skills --skill build-workspace-docs in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/build-workspace-docs/ (personal) or .claude/skills/build-workspace-docs/ (project).
Which AI agents can use build-workspace-docs?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is build-workspace-docs safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains build-workspace-docs?
It is published by moizibnyousaf in moizibnyousaf/ai-agent-skills. It has 169 recorded installs.
More from moizibnyousaf/ai-agent-skills
code-review
moizibnyousaf/ai-agent-skills
Automated code review for pull requests using specialized review patterns. Analyzes code for quality, security, performance, and best practices. Use when reviewing code changes, PRs, or doing code audits.
backend-development
moizibnyousaf/ai-agent-skills
Backend API design, database architecture, microservices patterns, and test-driven development. Use for designing APIs, database schemas, or backend system architecture.
database-design
moizibnyousaf/ai-agent-skills
Database schema design, optimization, and migration patterns for PostgreSQL, MySQL, and NoSQL databases. Use for designing schemas, writing migrations, or optimizing queries.
code-refactoring
moizibnyousaf/ai-agent-skills
Code refactoring patterns and techniques for improving code quality without changing behavior. Use for cleaning up legacy code, reducing complexity, or improving maintainability.
code-documentation
moizibnyousaf/ai-agent-skills
Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.
best-practices
moizibnyousaf/ai-agent-skills
Transforms vague prompts into optimized Claude Code prompts. Adds verification, specific context, constraints, and proper phasing. Invoke with /best-practices.
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown：查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件，或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.