docs: 完善项目说明和注释

2026-05-26 11:06:13 +08:00
commit cd70caafbc
29 changed files with 3165 additions and 0 deletions
@@ -0,0 +1,34 @@
+---
+name: readme-structure-sync
+description: Use this skill whenever files or directories are added, removed, renamed, or reorganized in the access-manage project. It ensures README.md stays synchronized with the actual project structure and package scripts.
+---
+
+# README Structure Sync
+
+When the project file structure changes, update `README.md` in the same change.
+
+## Required checks
+
+1. Run `rg --files -g '!node_modules' -g '!dist'` to inspect the current repository structure.
+2. If a directory or important file was added, removed, renamed, or moved, update the README directory section.
+3. If `package.json` scripts changed, update the README script section.
+4. Keep explanations practical: describe what each directory or important file is used for.
+5. Run `pnpm typecheck` after documentation-related changes when TypeScript source was also touched.
+
+## README sections to keep current
+
+- `目录结构`
+- `package.json 脚本说明`
+- `启动步骤`
+- `数据库迁移说明`
+
+## Standard
+
+The README should help a new developer understand:
+
+- where API routes live,
+- where business rules live,
+- where SQL lives,
+- how to start MySQL,
+- how to run migrations,
+- how to start and verify the backend.