文档站维护说明

本包已移除独立的 playground workspace 包。所有面向读者的示例、浏览器端交互演示与验收，均以 VitePress 文档站（docs/）为准。

本地开发

在 packages/shared 目录下：

pnpm run docs:dev

构建生产静态站：

pnpm run docs:build
pnpm run docs:preview

文档开发时，组件内可直接使用源码路径引用（与现有 Playground 一致），例如：

import { yourFunction } from '../../../src/functions/category/yourFunction'

发布前请确保 pnpm run build 已执行，以便 dist/ 与 package.json 的 exports 与对外 API 一致；文档站本身在开发模式下以 src 为主验证行为。

新增或修改一个函数时应交付的文档

1. API 页面：docs/api/{分类}/{函数名}.md

   • 包含：一句话说明、函数签名、参数表、返回值、工作原理。
   • 若函数带有 deps / env 参数，须说明前置依赖（表格列出各字段）。

2. 浏览器端函数：在 docs/.vitepress/components/ 增加 {PascalCase}Playground.vue（驼峰与函数名对应），并在对应 .md 顶部用 <script setup> 引入、在正文放置 <XxxPlayground />。

3. 侧边栏：在 docs/.vitepress/config.ts 的 /api/ 侧边栏中增加或调整链接，避免 404。

4. 类型与导出：若新增公开路径，运行 pnpm run build（会执行 generate-exports 等脚本），保证 zcw-shared/... 子路径可被消费方解析。

与 README 的关系

仓库根目录 README.md 描述依赖注入规范、目录约定与清单；操作步骤与文档站结构以本页与 README 中「文档规范」章节为准，二者如有不一致，以实际 docs/ 与 config.ts 为准并应逐步统一。

不再维护的内容

• 已删除 packages/shared/playground：不在 monorepo workspace 中单独保留脚本包。
• 不在仓库内维护 Node 单测目录 驱动全量函数回归；验证依赖 TypeScript 编译、构建与 文档站构建。

若业务项目需要自动化测试，请在应用仓库内对 zcw-shared 的调用编写用例，或自建 CI 调用上述命令。