From 0aadc1ae9ba76aba4ab417867917212ce0601d1b Mon Sep 17 00:00:00 2001
From: james <james@sctmes.com>
Date: Tue, 19 May 2026 22:49:37 +0800
Subject: [PATCH] Update README

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 43 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 0bdafde..38557c6 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,10 @@ DOCS_DIR=./docs
 
 ### 2. 构建并启动服务
 
+下载当前的docker-compose.yml文件放到项目根目录
+
+运行以下命令构建并启动服务：
+
 ```bash
 # 构建镜像并启动服务
 docker-compose up --build
@@ -45,6 +49,26 @@ docker-compose up --build
 docker-compose up --build -d
 ```
 
+**需要创建文档服务最小目录单元**
+
+```
+hf-mes-docs-vitepress/
+├── docs/                            # VitePress 文档目录 **生产时使用**
+│   ├── .vitepress/
+│   │   ├── config.mjs               # VitePress 配置
+│   │   ├── vitepress-pdf.config.ts  # PDF 导出配置
+│   │   └── theme/
+│   │       ├── index.ts             # 自定义主题入口，图片放大缩小配置
+│   │       └── style/
+│   │           └── print.css        # 打印样式，用于pdf导出
+│   ├── index.md                     # 首页
+│   ├── guide/                       # 指南目录(可选)
+│   ├── getting-started/             # 入门目录(可选)
+│   └── ...                          # 其他文档(可选)
+├── docker-compose.yml               # Docker Compose 配置
+└── .env                             # 环境变量配置
+```
+
 ### 3. 验证服务状态
 
 访问以下地址确认服务正常运行：
@@ -52,27 +76,31 @@ docker-compose up --build -d
 - **VitePress 文档**: http://localhost:3000
 - **API 健康检查**: http://localhost:3001/health
 
-## 目录结构
+## 目录结构（全项目）
 
 ```
 hf-mes-docs-vitepress/
 ├── docker/
 │   ├── api/
-│   │   ├── server.js          # API 服务主文件
-│   │   └── package.json        # API 依赖
-│   ├── Dockerfile              # Docker 镜像构建文件
-│   └── docker-entrypoint.sh    # 容器启动脚本
-├── docs/                       # VitePress 文档目录 **生产时使用**
+│   │   ├── server.js                # API 服务主文件
+│   │   └── package.json             # API 依赖
+│   ├── Dockerfile                   # Docker 镜像构建文件
+│   └── docker-entrypoint.sh         # 容器启动脚本
+├── docs/                            # VitePress 文档目录 **生产时使用**
 │   ├── .vitepress/
-│   │   ├── config.mjs         # VitePress 配置
-│   │   └── vitepress-pdf.config.ts  # PDF 导出配置
-│   ├── index.md               # 首页
-│   ├── guide/                  # 指南目录
-│   ├── getting-started/        # 入门目录
-│   └── ...                    # 其他文档
-├── docker-compose.yml          # Docker Compose 配置
-├── package.json               # 项目依赖 **构建docker时使用**
-└── .env                       # 环境变量配置
+│   │   ├── config.mjs               # VitePress 配置
+│   │   ├── vitepress-pdf.config.ts  # PDF 导出配置
+│   │   └── theme/
+│   │       ├── index.ts             # 自定义主题入口，图片放大缩小配置
+│   │       └── style/
+│   │           └── print.css        # 打印样式，用于pdf导出
+│   ├── index.md                     # 首页
+│   ├── guide/                       # 指南目录(可选)
+│   ├── getting-started/             # 入门目录(可选)
+│   └── ...                          # 其他文档(可选)
+├── docker-compose.yml               # Docker Compose 配置
+├── package.json                     # 项目依赖 **构建docker时使用**
+└── .env                             # 环境变量配置
 ```
 
 ## 常用命令