mcpField
D
docs-and-website-sync

docs-and-website-sync

github.com/sonofmagicDevelopment2278 installsUpdated 4d ago
Repository

About docs-and-website-sync

A skill for keeping public project documentation aligned with implementation, intended for teams maintaining websites, READMEs, docs, and AI skills. It verifies changes against source code, maps them to affected documentation, and runs scoped checks.

Key features

  1. 01Verify capabilities against source
  2. 02Map changes to documentation entry points
  3. 03Sync websites, READMEs, and skills
  4. 04Refresh generated assets with scripts
  5. 05Run checks scoped to the changes

Use cases

  1. 01Update guides after adding CLI commands
  2. 02Align configuration and package docs
  3. 03Check documentation entry points after skill changes
  4. 04Validate a website documentation build

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/sonofmagic/skills --skill docs-and-website-sync

After installing, type/docs-and-website-syncin Claude Code to confirm it loaded.

Bundled filesagents/openai.yamlreferences/docs-sync-checklist.md

Details

From the project README

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 prepare
    • forwardConsole / mcp init|print|doctor
    • wv screenshot / wv compare / wv ide logs
    • wv analyze --markdown|--report pr|--budget-check|--hmr-profile 与 weapp.analyze
    • web runtime / lib mode / 多平台 / npm / 分包 / worker
    • React 19 / JSX/TSX / mpcore headless parity
    • create-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。
  • React runtime、render mode 和组件 bridge：使用 weapp-vite-react-best-practices。

核心流程

  1. 先查事实来源，不要在旧文案之间互相复制：
    • packages/weapp-vite/src/types/config/**
    • packages/weapp-vite/src/cli/**
    • packages/weapp-ide-cli/src/cli/**
    • packages-runtime/react/src/**
    • packages-runtime/wevu/src/**
    • mpcore/packages/**
    • packages/weapp-vite/docs/README.md
    • packages/weapp-vite/docs/mcp.md
    • packages/weapp-vite/docs/volar.md
    • packages/weapp-vite/docs/define-config-overloads.md
    • packages/weapp-vite/docs/packaged/**
    • packages/weapp-vite/scripts/sync-package-docs.mjs
    • packages/create-weapp-vite/src/agents.ts
    • packages/create-weapp-vite/src/skills.ts
    • skills/*/SKILL.md
  2. 建立“能力变化 -> 入口页”映射，再统一修改：
    • 配置变化：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
    • React：website/config/react.md、docs/integration/react.md、React 模板与 @weapp-vite/react README
    • 多平台与 headless：website/guide/multi-platform.md、mpcore package docs、provider-compatible e2e
  3. 同步 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
    • 分析报告 -> wv analyze --markdown|--report pr|--budget-check|--hmr-profile
    • .weapp-vite 支持文件 -> wv prepare
  4. 生成资产只通过脚本或构建刷新，不手改：
    • website/public/llms-index.json
    • website/public/seo-quality-report.json
  5. 若新增、删除或合并 skill，同时更新：
    • website/guide/skills.md
    • website/guide/ai-workflows.md
    • website/guide/ai.md
    • website/.vitepress/components/AiLearningPage.vue
    • skills/skill-trigger-regression-checklist.md
    • skills/scripts/score-skill-trigger-regression.mjs
    • CLAUDE.md 与脚手架 AGENTS.md 模板
  6. 按最小范围验证：
    • 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

能力主题映射

  • HMR：以 packages/weapp-vite/docs/packaged/weapp-config.md、website/config/hmr.md 和真实 e2e 为准。
  • 插件：以 pluginRoot 类型、website/guide/plugin.md、模板 AGENTS 和 dist-plugin 验收为准。
  • router/Web runtime：分别核对 packages-runtime/wevu/docs/router-*.md 与 website/guide/web-runtime-*.md，不要合并成浏览器语义。
  • native AST/HMR 性能：同步 profile、fallback 和 correctness 结论，不只同步倍率宣传。
  • React/Wevu JSX：明确项目级 owner、微信平台限制和 bridge 边界，不把两条 JSX 编译链混写。
  • mpcore parity：同步 provider 选择、三层覆盖和“真实 DevTools 行为为准”的增量规则。
  • skill 元数据：每个公开 skill 都应有 agents/openai.yaml，并在触发回归清单中有主场景、边界场景和冲突场景。

约束

  • 不要跳过源码核对直接改文案。
  • 不要只改单一入口，遗漏 README、website、packaged docs 或 skills。
  • 不要手工维护生成资产。
  • 不要把小程序运行时截图能力写成泛化的浏览器截图。
  • 不要忽略脚手架生成的 AGENTS.md 与本地 dist/docs，它们属于当前产品合约。

输出

应用本 skill 时，输出必须包含：

  • 能力变化点。
  • 受影响入口列表。
  • 具体修改文件。
  • 验证命令。
  • 如有生成资产，说明刷新方式。

完成标记

  • 配置页、CLI 页、AI 指南、包说明、skills 与真实实现一致。
  • wv / weapp-vite 双命令、prepare、mcp init|print|doctor、forwardConsole、analyze、screenshot/compare/ide logs 没有文档漂移。
  • create-weapp-vite 的 AI skills 安装与 AGENTS.md 模板说明一致。
  • 本地随包文档 dist/docs 的优先级已经写清楚。

参考资料

  • references/docs-sync-checklist.md

Comments

Markdown supported