docs-up
Audit code changes on the current branch and update docs/ + .claude/rules/ to stay in sync. Run before /pr.
14 stars
Best use case
docs-up is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Audit code changes on the current branch and update docs/ + .claude/rules/ to stay in sync. Run before /pr.
Teams using docs-up should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
$curl -o ~/.claude/skills/docs-up/SKILL.md --create-dirs "https://raw.githubusercontent.com/spideystreet/medox/main/.claude/skills/docs-up/SKILL.md"
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/docs-up/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How docs-up Compares
| Feature / Agent | docs-up | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Audit code changes on the current branch and update docs/ + .claude/rules/ to stay in sync. Run before /pr.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# 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 ```bash git diff main...HEAD --name-only ``` Categorize changed files into impact zones: | Changed path pattern | Docs 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.py` | `docs/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.yml` | `docs/dbt/overview.mdx`, `docs/pipeline/silver.mdx` | | `tests/e2e/prompts.yaml` | no 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`
Related Skills
We are still matching the closest adjacent skills for this page. In the meantime, continue through the full directory.