---
description: 修改或新增 src/ 代码时同步更新 docs/ 技术文档
globs: src/**/*
alwaysApply: false
---

# 文档同步规则

当你在 `src/` 下**新增或修改**任何文件时，必须同步更新 `docs/` 中对应的技术文档。

## 文件映射关系

| 源文件 | 文档路径 |
|--------|----------|
| `src/api/*.ts` | `docs/api/*.md` |
| `src/stores/*.ts` | `docs/stores/*.md` |
| `src/composables/*.ts` | `docs/composables/*.md` |
| `src/views/*.vue` | `docs/views/*.md` |
| `src/components/*.vue` | `docs/components/*.md` |
| `src/main.ts` | `docs/core/main.md` |
| `src/App.vue` | `docs/core/App.md` |
| `src/router/index.ts` | `docs/core/router.md` |
| `src/plugins/*.ts` | `docs/core/*.md`（如 vuetify.md） |

## 文档结构要求

每个文档需包含以下三部分：

1. **功能用途**：该文件/模块的职责与核心能力
2. **使用方式**：调用示例、Props/Events、API 用法
3. **扩展方式**：如何修改、新增功能

API 与组件文档需补充类型说明、Props、Events 等。

## 示例

修改 `src/api/event.ts` 后，需更新 `docs/api/event.md`；新增 `src/api/order.ts` 时，需新建 `docs/api/order.md`。