Build Workspace Docs
- 137 installs
- 1.1k repo stars
- Updated May 5, 2026
- skillcreatorai/ai-agent-skills
Scaffold and maintain workspace documentation tailored for coding agents, covering repo layout, conventions, commands, and context files agents need to work safely in unfamiliar codebases.
About
The build-workspace-docs skill from skillcreatorai/ai-agent-skills creates and maintains agent-oriented workspace documentation such as context maps, conventions, and runbooks. It helps coding agents orient quickly, follow project rules, and execute tasks with fewer wrong assumptions in complex repositories.
- Repo map and convention capture
- Agent context file scaffolding
- Command and workflow references
- Safe-handling notes for sensitive areas
- Incremental doc updates as code evolves
Build Workspace Docs by the numbers
- 137 all-time installs (skills.sh)
- +2 installs in the week ending Aug 5, 2026 (Skillselion tracking)
- Ranked #3,568 of 16,546 AI & Agent Building skills by installs in the Skillselion catalog
- Data as of Aug 5, 2026 (Skillselion catalog sync)
npx skills add https://github.com/skillcreatorai/ai-agent-skills --skill build-workspace-docsAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 137 |
|---|---|
| repo stars | ★ 1.1k |
| Last updated | May 5, 2026 |
| Repository | skillcreatorai/ai-agent-skills ↗ |
What it does
Scaffold and maintain workspace documentation tailored for coding agents, covering repo layout, conventions, commands, and context files agents need to work safely in unfamiliar codebases.
Files
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
1. Preview what would change.
npx ai-agent-skills build-docs --dry-run2. Regenerate the docs.
npx ai-agent-skills build-docs3. Verify the output.
npx ai-agent-skills build-docs --dry-run --format jsonThe 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.
Related skills
Setup Matt Pocock SkillsScaffold the per-repo configuration that Matt Pocock’s engineering agent skills rely on so they understand the issue tracker, triage labels, and domain documentation la495k196k
Lark AppsConnect Claude, Cursor or custom agents directly to Lark (Feishu) for messaging, document automation, approval workflows and enterprise data access.402k
CavemanSlash token usage by roughly 75% while keeping every technical detail intact when working with Claude Code, Cursor or similar agents.391k94.7k
Lark Skill MakerQuickly turn any Lark/Feishu OpenAPI call or multi-step workflow into a reusable agent skill with its own SKILL.md.386k16k
Running Claude Code Via Litellm CopilotRun Claude Code at a fraction of the cost by routing requests through LiteLLM to the GitHub Copilot Chat API.270k72
Codex PetGenerate a complete Codex Pet spritesheet and metadata from one reference image without needing an OpenAI key or Codex Pro.246k10