القائمة
Update documentation in docs/public/ based on recent code changes. Reads git history since a watermark commit, maps changed files to doc pages, and makes surgical edits to keep docs in sync with code.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | update-docs |
| description | Update documentation in docs/public/ based on recent code changes. Reads git history since a watermark commit, maps changed files to doc pages, and makes surgical edits to keep docs in sync with code. |
Detect code changes since the last run and update affected documentation pages.
CONTRIBUTING.md and AGENTS.md (repo root) for writing styleRead .claude/skills/docs/watermark for the last processed commit SHA. If the file is missing (first run), use the commit from 30 days ago as the starting point: git log --before="30 days ago" --format=%H -1 main.
Run git log --oneline --no-merges --name-only <watermark>..HEAD to get changed files and commit messages since the watermark.
Cross-reference changed files against the code-to-doc mapping in references/mapping.md. Also use judgment for unmapped files (e.g., new crates or modules that clearly affect user-facing behavior).
Filter to user-facing behavioral changes only:
Skip:
If nothing affects docs, tell the user and stop.
For each affected doc page: read the current MDX file and the relevant source files. Identify sections that are outdated, missing, or incorrect.
Surgical edits only — change only affected sections. Preserve existing voice, structure, heading hierarchy, and Mintlify component usage.
docs/public/api-reference/fabro-api.yaml — that is the API workflow's source of truthIf any updated page contains ```dot code blocks with digraph definitions, run ./test/docs/run_tests.sh validate. Fix any failures before proceeding.
Write the output of git rev-parse HEAD to .claude/skills/docs/watermark.
List updated doc pages and what changed in each.