Skip to content
cccskills
FreePublished on GitHub

codex-docs-change-sync

Use when code changes may require documentation updates; maps git diff to candidate docs without auto-editing documentation.

The English summary is being prepared. Showing the original description.

See how to install

Files included (5)

  • SKILL.md1.6 KB
  • agents/openai.yaml228 B
  • references/docs-sync-spec.md1.1 KB
  • references/mapping-rules.md1.1 KB
  • scripts/map_changes_to_docs.py14.8 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

TL;DR

Map code changes to affected documentation via map_changes_to_docs.py. Report-only by default, no auto-edit. Scope: auto-detect staged -> unstaged -> last commit. Fallback: manual diff inspection.

Codex Docs Change Sync

Purpose

Identify documentation that is likely affected by code changes.

Activation

  1. Activate during workflow docs steps.
  2. Activate on explicit $codex-docs-change-sync.

Script Invocation

  • Use map_changes_to_docs.py for report-only docs impact mapping.
  • See skills/.system/REGISTRY.md for full script paths.

Script Invocation Discipline

  1. Always run --help before invoking map_changes_to_docs.py.
  2. Treat the script as a black-box mapper and prefer direct execution over source inspection.
  3. Read script source only when customization or bug fixing is required.

Enhanced Diff Scope

If scope is not specified, use auto mode:

  1. staged changes
  2. unstaged changes
  3. last commit

Report which scope was selected.

Behavior

  1. Run script and parse JSON output.
  2. Report changed files and candidate docs with reason/confidence.
  3. Keep MVP in report-only mode; do not auto-edit docs unless user requests it.

Fallback

If script cannot run, inspect diffs manually and report likely docs: docs/, README.md, CHANGELOG.md, and module-specific docs.

Reference Files

  • references/docs-sync-spec.md: script behavior, output format, and fallback protocol.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Use when implementation is complete, all tests pass, and you need to decide how to integrate the work — guides completion of development work by presenting structured options for merge, PR, or cleanup

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

Use when a project has 50+ files, missing context, or explicit $codex-genome request; generates multi-layer project context to reduce hallucination.

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

Use for DESIGN.md visual identity contracts; author, scaffold, lint, diff, and export design contracts with the upstream spec and CLI.

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

Use when the task involves reading, creating, or editing `.docx` documents, especially when formatting or layout fidelity matters; prefer `python-docx` plus the bundled `scripts/render_docx.py` for visual checks.

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

Use for documents, reports, memos, guides, academic papers, or formal text that needs clear structure, reliable tone, formatting, and diagrams.

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

Use when frontend, backend, mobile, data, DevOps, or security work needs domain routing and at most four focused references.

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

See all skills by Bang-isme

Report a problem with this skill