Agent skill

sync-specs

Use when code changes may have made documentation outdated, when reviewing docs for consistency, or when the user asks to sync or audit documentation.

View SKILL.md on GitHub Repository
Stars 2,488
Forks 203

Install this agent skill to your Project

npx add-skill https://github.com/nexu-io/nexu/tree/main/skills/localdev/sync-specs

SKILL.md

Documentation Sync

Review code changes and update project documentation for consistency.

Mode

Mode How to activate Behavior
delta (default) No argument, or say "delta" Diff against merge-base with origin/main + working tree changes
full Say "full audit" or "full sync" Complete audit of all docs against current codebase
Scope keyword Say the keyword (e.g. "db", "api") Targeted check (see Scope Filters below)

Delta Mode Baseline

Identify changed files using merge-base (not a fixed commit count):

bash
# Branch changes since diverging from main
git diff --name-only $(git merge-base HEAD origin/main)...HEAD
# Plus staged + unstaged
git diff --name-only --cached
git diff --name-only

Combine the results into a single list of changed files. Then use the Impact Mapping to identify which docs may need updates.

Impact Mapping

Map changed areas to the docs they affect:

Changed area Affected docs
apps/controller/src/routes/ specs/references/api-patterns.md, ARCHITECTURE.md, specs/product-specs/*.md (if route is user-facing)
apps/web/src/pages/ or apps/web/src/app.tsx specs/FRONTEND.md
apps/landing/ ARCHITECTURE.md (Monorepo layout)
apps/controller/src/runtime/ ARCHITECTURE.md, specs/RELIABILITY.md
packages/shared/src/schemas/ ARCHITECTURE.md (Type safety)
package.json scripts CLAUDE.md + AGENTS.md Commands sections
New apps/packages dirs ARCHITECTURE.md (Monorepo layout)
Config generator specs/references/openclaw-config-schema.md, specs/openclaw-config-reference.md
Auth changes specs/SECURITY.md
New/moved doc files CLAUDE.md Doc Map, AGENTS.md Where to look, relevant index files

Cross-Reference Pairs

Always verify consistency between these paired docs:

  1. CLAUDE.md Commands section <-> AGENTS.md Commands section (same entries)
  2. CLAUDE.md Documentation Map paths <-> actual files on disk
  3. CLAUDE.md Hard Rules <-> AGENTS.md Hard rules
  4. ARCHITECTURE.md monorepo layout <-> actual apps/ + packages/ dirs
  5. specs/DESIGN.md table <-> actual specs/design-specs/ + specs/designs/ contents
  6. specs/design-specs/index.md table <-> actual design files
  7. specs/product-specs/index.md table <-> actual specs/product-specs/*.md files
  8. specs/PLANS.md table <-> specs/exec-plans/{active,completed}/ contents
  9. specs/FRONTEND.md Pages table <-> apps/web/src/app.tsx routes

Scope Filters

When the user specifies a scope keyword, limit the check to that area:

Keyword What it checks
db Schema source vs specs/generated/db-schema.md
api Route files vs specs/references/api-patterns.md
frontend apps/web/ vs specs/FRONTEND.md
commands package.json scripts vs CLAUDE.md/AGENTS.md Commands sections
architecture All apps/ + packages/ vs ARCHITECTURE.md layout
security Auth/crypto code vs specs/SECURITY.md
links Verify all doc map paths and index references resolve to existing files
guides specs/guides/** internal cross-references
designs specs/designs/** + specs/design-specs/** vs index files
exec-plans specs/exec-plans/** vs specs/PLANS.md
product-specs specs/product-specs/** vs index + specs/PRODUCT_SENSE.md

Rules

  1. Never remove forward-looking documentation — ask if uncertain whether content is aspirational or stale.
  2. Preserve original language (English/Chinese) and writing style of existing docs.
  3. For backend API updates, treat apps/controller as the source of truth; do not reference removed legacy package paths.
  4. Always verify CLAUDE.md <-> AGENTS.md consistency after any update to either file.
  5. Do NOT auto-commit — present the diff summary and let the user decide when to commit.

Workflow

  1. Determine mode from user request (default: delta).
  2. If delta mode: run the git diff commands above, collect changed files.
  3. Map changed files to affected docs using the Impact Mapping.
  4. Read each affected doc and compare against current code.
  5. Check all Cross-Reference Pairs for consistency.
  6. Present findings: what's outdated, what's missing, what's inconsistent.
  7. Apply fixes with user approval.
  8. After fixes, re-verify Cross-Reference Pairs touched by changes.

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

nexu-io/nexu

libtv-video

2,488 203
Explore
nexu-io/nexu

coding-agent

Delegate coding tasks to Codex, Claude Code, or Pi agents via background process. Use when: (1) building/creating new features or apps, (2) reviewing PRs (spawn in temp dir), (3) refactoring large codebases, (4) iterative coding that needs file exploration. NOT for: simple one-liner fixes (just edit), reading code (use read tool), thread-bound ACP harness requests in chat (for example spawn/run Codex or Claude Code in a Discord thread; use sessions_spawn with runtime:"acp"), or any work in ~/clawd workspace (never spawn agents here). Claude Code: use --print --permission-mode bypassPermissions (no PTY). Codex/Pi/OpenCode: pty:true required.

2,488 203
Explore
nexu-io/nexu

gh-issues

Fetch GitHub issues, spawn sub-agents to implement fixes and open PRs, then monitor and address PR review comments. Usage: /gh-issues [owner/repo] [--label bug] [--limit 5] [--milestone v1.0] [--assignee @me] [--fork user/repo] [--watch] [--interval 5] [--reviews-only] [--cron] [--dry-run] [--model glm-5] [--notify-channel -1002381931352]

2,488 203
Explore
nexu-io/nexu

deep-research

深度调研方法论（8步法）：将模糊主题转化为高质量调研报告。 触发词：/deep-research、深度调研、帮我调研、调研一下、对比分析 注意：如果用户需要的是可视化图谱而非报告，请使用 research-to-diagram skill。

2,488 203
Explore
nexu-io/nexu

research-to-diagram

深度调研主题并自动生成知识关系图谱PDF。接收研究主题后自动进行网络调研、信息收集、知识整理，最终生成专业的可视化关系图谱。适用于"研究...并做图"、"深度分析...并可视化"、"生成知识图谱"等场景。

2,488 203
Explore
nexu-io/nexu

Nano Banana One Shop

All-in-one image generation with Gemini models. Supports Nano Banana (3.1 Flash), Nano Banana Pro (3 Pro), and Nano Banana 2 (2.5 Flash). Triggers on "generate image", "image generation", "nano banana", "edit image".

2,488 203
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results