Instruction file imported from lewkamtao/lew-ui (.cursor/rules/base.mdc). Copyright stays with the author.

组件开发基础规范

1. 组件修改后的文档更新要求

每次修改完组件内容后，必须同步更新以下内容：

• 文档示例：更新 docs/docs/{component}/demo/ 下受影响的示例与代码片段
• API 导出：更新 docs/docs/{component}/api/ 下的 props、emits、model 等导出
• 文案与说明：按需同步更新 docs/locals/ 中的组件名称、描述、API 说明等国际化文案

2. 文档生成规范

• ❌ 不需要生成总结文档：修改组件时，不要生成额外的总结性文档或变更说明文档
• ❌ 不需要生成组件根目录 .mdc 文档：组件目录下不再维护单独的组件说明文件
• ✅ 直接更新现有文档系统：文档统一维护在 docs/docs/、docs/locals/ 和 API 导出文件中

3. 缺失文档的处理

如果组件缺少文档配套内容，需要：

1. 在 docs/docs/{component}/ 下补齐入口、示例和 API 导出
2. 在 docs/locals/ 中补齐组件名称、描述和 API 文案
3. 保持文档演示、API 表格和组件实现一致

组件目录结构示例：

lib/components/general/avatar/
├── index.ts
└── src/
    ├── LewAvatar.vue
    └── props.ts