跳到正文
cccskills
免费在 GitHub 公开

docs-up

Audit code changes on the current branch and update docs/ + .claude/rules/ to stay in sync. Run before /pr.

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

查看安装方法

包含的文件(1)

  • SKILL.md2.6 KB

SKILL.md(原文)

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

Skill: Sync Docs

Audit all code changes on the current branch vs main, then update documentation files to reflect those changes.

Steps

1. Identify what changed

git diff main...HEAD --name-only

Categorize changed files into impact zones:

Changed path patternDocs impact
src/medox/agent/tools/docs/agent/tools.mdx, .claude/rules/agent.md
src/medox/agent/nodes/docs/agent/overview.mdx, docs/agent/guardrails.mdx
src/medox/agent/graph_agent.pydocs/agent/overview.mdx
src/medox/pipeline/assets/docs/pipeline/overview.mdx, .claude/rules/pipeline.md
src/medox/pipeline/io/docs/pipeline/silver.mdx, docs/pipeline/bronze.mdx
dbt/models/silver/docs/dbt/overview.mdx, docs/pipeline/silver.mdx, .claude/rules/dbt.md
dbt/models/sources.ymldocs/dbt/overview.mdx, docs/pipeline/silver.mdx
tests/e2e/prompts.yamlno docs change needed
tests/ (other)no docs change needed
scripts/docs/development/setup.mdx (if new script)

2. For each impacted doc, read it and check for staleness

For each doc file identified above:

  1. Read the current doc file
  2. Read the changed source files
  3. Compare: are there new entities (tools, models, assets, nodes) missing from the doc?
  4. Compare: are there renamed/removed entities still referenced in the doc?
  5. Compare: are there changed behaviors (e.g. new parameters, new strategies) not reflected?

3. Apply updates

For each stale doc:

  • Add new entries to tables, diagrams, and source lists
  • Update descriptions that no longer match the code
  • Remove references to deleted entities
  • Keep the existing style and structure of each doc file

Also check .claude/rules/ files:

  • agent.md — tools table, node list
  • pipeline.md — asset graph, key files table
  • dbt.md — current Silver models list

4. Report

After all edits, output a summary:

Docs synced:
- docs/agent/tools.mdx — updated check_interactions section
- docs/pipeline/overview.mdx — added new asset
- (no changes needed for docs/dbt/overview.mdx)

If no docs need updating, report: "All docs are up to date."

Rules

  • Never rewrite entire sections — make minimal, targeted edits
  • Keep all docs in English (same as code comments)
  • Do not touch docs/introduction.mdx or docs/quickstart.mdx unless the overall architecture changed
  • Do not commit — leave changes staged for the user to review before /pr

评价

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

评论

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

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

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

0 / 1000 字

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

同一仓库的技能

Add a tool function to the Medox agent. Use when creating a tool file, registering it in the API loop, and writing its test.

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

spideystreet/medox132026年10月1日 更新

Add a new E2E test case to tests/e2e/prompts.yaml for LangSmith evaluation. Use when adding interaction pairs to test, covering new ANSM drug classes, or rebalancing eval coverage.

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

spideystreet/medox132026年10月1日 更新

commit

免费

Create a git commit with Medox conventions (co-author, conventional type/scope). Invoke manually with /commit — do NOT trigger automatically.

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

spideystreet/medox132026年10月1日 更新

lint

免费

Run all project linters (ruff, mypy, sqlfluff) and report results. Invoke with /lint.

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

spideystreet/medox132026年10月1日 更新

Add a new Dagster asset to the pipeline. Use when creating a Bronze, Silver, or Gold layer asset.

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

spideystreet/medox132026年10月1日 更新

Create a new dbt Silver model with SQL + YAML contract. Use when adding a new Silver layer model from a raw source table.

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

spideystreet/medox132026年10月1日 更新

查看 spideystreet 的全部技能

报告此技能的问题