← ClaudeAtlas

docs-incremental-updatelisted

Incrementally update Mintlify documentation (.mdx) from Python source changes only. Use when: (1) Python files referenced in doc_code_map frontmatter have changed, (2) a PR touches Python modules documented in docs/mintlify/key_modules/ or docs/mintlify/mcp/, (3) the user asks to sync docs after Python code changes. Prefer minimal diffs and leave correct content untouched.
HIDORAKAI002/ai-workspace-archive · ★ 31 · AI & Automation · score 72
Install: claude install-skill HIDORAKAI002/ai-workspace-archive
# Docs Incremental Update Update Mintlify .mdx documentation so it stays in sync with CAMEL source code. ## Scope - Only use this skill when the driver is **Python source changes** referenced by a target document's `doc_code_map`. - Do **not** use it for docs-only edits, workflow/YAML changes, or broad wording cleanups without Python changes. - Prefer **no document change** when Python edits are internal and do not affect public API, behavior, configuration, examples, or reader understanding. ## Edit Rule Use terminal tools to inspect the target doc, inspect any relevant code, and edit the target doc directly. Keep changes scoped to that doc and preserve its frontmatter. CI treats the run as successful based on the resulting target doc file state, not on any special status token in the chat response. ## Quick Reference | Item | Path | |------|------| | Doc roots | `docs/mintlify/` | | Mapping utility | `docs/mintlify/scripts/docs_sync/doc_code_map.py` | | Auto-sync script | `.camel/skills/docs-incremental-update/scripts/auto_sync_docs_with_chatagent.py` | | Workflow | `.github/workflows/docs_release_auto_sync_pr.yml` | ## Workflow ### Step 1 — Identify Impacted Docs Determine which `.mdx` files are affected by the code change. ```bash # From repo root, pass only changed Python files python docs/mintlify/scripts/docs_sync/doc_code_map.py impacted \ --changed-file <file1> --changed-file <file2> # Or using git refs python docs/mintlify/scripts/docs_sync/doc_