Files
role-admin/.codex/skills/readme-structure-sync/SKILL.md
T
2026-05-26 11:30:03 +08:00

1.2 KiB

name, description
name description
readme-structure-sync Use this skill when changing files, folders, package scripts, routes, API modules, or project conventions in role-admin; it ensures README.md stays synchronized with the current repository structure.

README Structure Sync

Use this skill whenever a task changes repository structure, important entry files, package scripts, routes, API modules, environment variables, or collaboration conventions.

Workflow

  1. Inspect the touched files and decide whether they affect README.md.
  2. If directories or key files were added, removed, renamed, or moved, update the README.md directory map.
  3. If package.json scripts changed, update the README.md important scripts table.
  4. If business modules, API contracts, routes, or environment variables changed, update the matching README section.
  5. Keep README descriptions short and operational: what the file or directory does, not a generic framework explanation.

Touch-Up Rule

Do not scan the whole repository only for this skill. When a task already touches applicable files, fix obvious README drift in the same pass. If full cleanup is larger than the request, update the current workflow and top-level declarations, then call out the remaining gap.