docs-and-website-sync
docs-and-website-sync
用途
根据仓库真实能力,更新 website、docs、README、skills、脚手架 AI 指引和随包文档,避免公开入口落后于实现。
何时使用
- 用户要求“根据现有代码更新 website/docs/skills”。
weapp-vite、wevu、weapp-ide-cli或脚手架新增了配置、CLI 命令、AI 工作流。- 网站配置页、AI 指南、包说明和 skills 之间出现漂移。
- 新增或调整这些公开能力:
weapp.autoRoutes/routeRules/ layout.weapp-vite支持文件与wv prepareforwardConsole/mcp init|print|doctorwv screenshot/wv compare/wv ide logswebruntime /libmode / 多平台 / npm / 分包 / workercreate-weapp-vite的 AI skills 安装与AGENTS.md
不适用场景
本 skill 聚焦“对外文档与技能入口同步”。
- 工程配置、构建策略、CLI 分发:使用
weapp-vite-best-practices。 .vue宏、模板和 SFC 兼容:使用weapp-vite-vue-sfc-best-practices。wevu运行时语义:使用wevu-best-practices。- DevTools runtime e2e:使用
weapp-devtools-e2e-best-practices。
核心流程
- 先查事实来源,不要在旧文案之间互相复制:
packages/weapp-vite/src/types/config/**packages/weapp-vite/src/cli/**packages/weapp-ide-cli/src/cli/**packages/weapp-vite/docs/README.mdpackages/weapp-vite/docs/mcp.mdpackages/weapp-vite/docs/volar.mdpackages/weapp-vite/docs/define-config-overloads.mdpackages/weapp-vite/docs/packaged/**packages/weapp-vite/scripts/sync-package-docs.mjspackages/create-weapp-vite/src/agents.tspackages/create-weapp-vite/src/skills.tsskills/*/SKILL.md
- 建立“能力变化 -> 入口页”映射,再统一修改:
- 配置变化:
website/config/** - CLI / AI / MCP:
website/guide/**、website/packages/**、website/.vitepress/components/AiLearningPage.vue、packages/weapp-vite/README.md - 脚手架与 AI 约束:
website/packages/create-weapp-vite.md、packages/create-weapp-vite/src/agents.ts - 运行时与框架:
website/config/vue.md、website/config/wevu.md、website/packages/web.md
- 配置变化:
- 同步 AI 合约口径:
- 先读根
AGENTS.md - 再读
node_modules/weapp-vite/dist/docs/*.md MCP 接入->wv mcp init|print|doctor <codex|claude-code|cursor>运行时检查->weapp_devtools_*/weapp_runtime_*tools截图->wv screenshot/take_weapp_screenshot截图对比->wv compare/compare_weapp_screenshot日志->wv ide logs --open.weapp-vite支持文件 ->wv prepare
- 先读根
- 生成资产只通过脚本或构建刷新,不手改:
website/public/llms-index.jsonwebsite/public/seo-quality-report.json
- 若新增、删除或合并 skill,同时更新:
website/guide/skills.mdwebsite/guide/ai-workflows.mdwebsite/guide/ai.mdwebsite/.vitepress/components/AiLearningPage.vueskills/skill-trigger-regression-checklist.mdskills/scripts/score-skill-trigger-regression.mjsCLAUDE.md与脚手架AGENTS.md模板
- 按最小范围验证:
pnpm exec eslint --no-warn-ignored skills/*/SKILL.md- 涉及
website/**时跑pnpm --filter website-weapp-vite build - 涉及 skill 触发/评分时再跑
pnpm skills:check:yaml、pnpm skills:score:json
约束
- 不要跳过源码核对直接改文案。
- 不要只改单一入口,遗漏 README、website、packaged docs 或 skills。
- 不要手工维护生成资产。
- 不要把小程序运行时截图能力写成泛化的浏览器截图。
- 不要忽略脚手架生成的
AGENTS.md与本地dist/docs,它们属于当前产品合约。
输出
应用本 skill 时,输出必须包含:
- 能力变化点。
- 受影响入口列表。
- 具体修改文件。
- 验证命令。
- 如有生成资产,说明刷新方式。
完成标记
- 配置页、CLI 页、AI 指南、包说明、skills 与真实实现一致。
wv/weapp-vite双命令、prepare、mcp init|print|doctor、forwardConsole、screenshot/compare/ide logs没有文档漂移。create-weapp-vite的 AI skills 安装与AGENTS.md模板说明一致。- 本地随包文档
dist/docs的优先级已经写清楚。
参考资料
references/docs-sync-checklist.md
More from sonofmagic/skills
weapp-tailwindcss
帮助用户在 uni-app、taro、uni-app x 与原生小程序项目中接入和排障 weapp-tailwindcss。Use when 用户提到 weapp-tailwindcss、小程序 Tailwind 不生效、rpx 任意值、JS 字符串 class、space-y/space-x、weapp-tw patch、content/@source、twMerge/cva/tv。
126weapp-vite-best-practices
面向采用 weapp-vite 项目布局仓库或已安装 `weapp-vite` 依赖项目的工程化实践手册,覆盖 `vite.config.ts` 的 `weapp` 配置、自动路由、routeRules/layout、自动导入组件、分包、npm、多平台、受管 TypeScript、`prepare`、`forwardConsole`、`mcp`、`screenshot/compare/ide logs`、Web runtime、lib mode、worker、`dist/docs`、脚手架 `AGENTS.md`、AI skills 安装,以及与 `weapp-ide-cli` 的命令治理和透传边界。
67wevu-best-practices
面向小程序中 wevu 运行时的实践手册,覆盖生命周期注册、响应式更新、事件契约、`bindModel/useBindModel`、`setPageLayout/usePageLayout`、根入口 `useNativeRouter/useNativePageRouter`、`wevu/router`、store 约束,以及 `setData`、渲染、页面切换、资源与内存性能治理。
61weapp-vite-vue-sfc-best-practices
面向使用 weapp-vite 的小程序项目的 Vue SFC 实践手册,覆盖 `<script setup lang="ts">`、JSON 宏、`definePageMeta`/layout、`defineModel`、`usingComponents`、模板指令兼容、`.weapp-vite` 类型支持文件、受管 `prepare` 工作流,以及和脚手架 `AGENTS.md` / 本地 `dist/docs` 对齐的当前 SFC 约定。
57playwright-cli
Automate browser interactions, test web pages and work with Playwright tests.
40native-to-weapp-vite-wevu-migration
面向将原生小程序迁移到 `weapp-vite + wevu + Vue SFC` 的结构化迁移工作流,覆盖分波次推进、行为等价改造、`Page/Component` 到 `.vue`、props/events 类型化、`definePageMeta`/layout、平台守卫、`.weapp-vite` 支持文件、自动路由与 AI 工作流对齐,以及迁移后的截图/日志/e2e 验证与回滚检查点。
40