xk-docs/AGENTS.md

AGENTS.md

What this is

VitePress documentation site for the XK project. Content source lives in docs/ (standard VitePress convention).

Commands

pnpm dev        # Dev server, docs from docs/
pnpm build      # Production build
pnpm preview    # Preview built site

Key dependencies

• vitepress 1.6.4 — static site generator
• vitepress-plugin-mermaid — diagram support (use mermaid fenced code blocks)
• @lucide/vue — icon components

Conventions

• Package manager: pnpm (lockfile version 9.0, pnpm-lock.yaml committed)
• Module type: ESM ("type": "module" in package.json)
• The UniappTool.xml in .idea/ is IDE config; no UniApp source files exist here

Documentation structure

docs/
├── .vitepress/config.ts    # VitePress 配置（导航、侧边栏）
├── index.md                # 首页
├── guide/                  # 指南
│   ├── introduction.md     # 项目介绍 + 技术栈
│   └── architecture.md     # 系统架构图
├── projects/               # 项目文档
│   ├── xk-admin/           # 管理后台 (Vue3 + Vben)
│   ├── xk-api/             # 新API (Laravel 12)
│   ├── xk-api-yii/         # 旧API (Yii2)
│   ├── xk-client-wx/       # 用户端小程序 (uni-app)
│   ├── xk-doctor-wx/       # 医生端小程序 (uni-app)
│   ├── xk-data/            # 数据大屏 (Vue3 + ECharts)
│   └── xk-hy-forward-go/   # 监管转发 (Go)
└── database/               # 数据库文档
    ├── overview.md          # 总览 + ER图
    ├── z-xk.md             # 新库 67张表
    └── z-o-xk.md           # 旧库 ~100张表

Source projects

The sibling directories contain the actual source code:

• xk-admin/ — Vue 3 + Vben Admin Pro monorepo
• xk-api/ — Laravel 12 (PHP 8.4+)
• xk-api-yii/ — Yii2 Advanced (legacy)
• xk-client-wx/ — uni-app patient WeChat mini-program
• xk-doctor-wx/ — uni-app doctor/staff WeChat mini-program
• xk-data/ — Vue 3 + ECharts data dashboard
• xk-hy-forward-go/ — Go internet hospital supervision proxy