본문으로 건너뛰기
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(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

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 / 1,000자

이 양식은 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의 스킬 모두 보기

이 스킬의 문제 신고