跳到正文
cccskills
免费在 GitHub 公开

build-workspace-docs

Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(1)

  • SKILL.md1.5 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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.
npx ai-agent-skills build-docs --dry-run
  1. Regenerate the docs.
npx ai-agent-skills build-docs
  1. 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, 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.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Clarify requirements before implementing. Do not use automatically, only when invoked explicitly.

中文简介正在准备中。当前显示原文说明。

MoizIbnYousaf/ai-agent-skills11522026年9月22日 更新

Use when checking the overall health of a skills library. Run doctor, validate, check for stale skills, and verify generated docs are in sync.

中文简介正在准备中。当前显示原文说明。

MoizIbnYousaf/ai-agent-skills11522026年9月22日 更新

Backend API design, database architecture, microservices patterns, and test-driven development. Use for designing APIs, database schemas, or backend system architecture.

中文简介正在准备中。当前显示原文说明。

MoizIbnYousaf/ai-agent-skills11522026年9月22日 更新

Transforms vague prompts into optimized Claude Code prompts. Adds verification, specific context, constraints, and proper phasing. Invoke with /best-practices.

中文简介正在准备中。当前显示原文说明。

MoizIbnYousaf/ai-agent-skills11522026年9月22日 更新

Use when exploring the ai-agent-skills catalog to find, compare, and evaluate skills before installing. Always use --fields to limit output size and --dry-run before committing to an install.

中文简介正在准备中。当前显示原文说明。

MoizIbnYousaf/ai-agent-skills11522026年9月22日 更新

Automatically creates user-facing changelogs from git commits by analyzing commit history, categorizing changes, and transforming technical commits into clear, customer-friendly release notes. Turns hours of manual changelog writing into minutes of automated generation.

中文简介正在准备中。当前显示原文说明。

MoizIbnYousaf/ai-agent-skills11522026年9月22日 更新

查看 MoizIbnYousaf 的全部技能

报告此技能的问题