codex-docs-change-sync
Use when code changes may require documentation updates; maps git diff to candidate docs without auto-editing documentation.
- License 许可
- MIT
- 最近更新
- 2026-07-15
- Stars
- ★ 2
- Forks
- 0
01 前言 Front Matter
- name
- codex-docs-change-sync
- description
- Use when code changes may require documentation updates; maps git diff to candidate docs without auto-editing documentation.
- load_priority
- lazy
02 资源文件 4
- 参考文档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
03 SKILL.md 正文
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
- Activate during workflow
docssteps. - Activate on explicit
$codex-docs-change-sync.
Script Invocation
- Use
map_changes_to_docs.pyfor report-only docs impact mapping. - See
skills/.system/REGISTRY.mdfor full script paths.
Script Invocation Discipline
- Always run
--helpbefore invokingmap_changes_to_docs.py. - Treat the script as a black-box mapper and prefer direct execution over source inspection.
- Read script source only when customization or bug fixing is required.
Enhanced Diff Scope
If scope is not specified, use auto mode:
- staged changes
- unstaged changes
- last commit
Report which scope was selected.
Behavior
- Run script and parse JSON output.
- Report changed files and candidate docs with reason/confidence.
- 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 using the
conventions in references/mapping-rules.md (path→doc mapping, reference-search
patterns, always-include rules): start from docs/, README.md, CHANGELOG.md,
and module-specific docs.
Reference Files
references/docs-sync-spec.md: script behavior, output format, and fallback protocol.references/mapping-rules.md: default code→docs mapping conventions, reference-search patterns, always-include rules, and confidence levels (the human-readable spec behind the script and the manual fallback).
04 同仓库更多 Skills
codex-test-driven-development
Fixture stub for TDD skill.
codex-subagent-execution
Fixture stub for subagent execution skill.
codex-runtime-hook
Fixture stub for runtime hook skill.
codex-plan-writer
Fixture stub for plan writer skill.
codex-execution-quality-gate
Fixture stub for quality gate skill.
codex-demo
Minimal fixture skill for Agency CLI skill-md parser tests.