diff --git a/README.md b/README.md index 57ce901..40ef1ee 100644 --- a/README.md +++ b/README.md @@ -38,16 +38,10 @@ tools/ │ ├── remote_loader.sh # 远程加载器 │ ├── demo_usage.sh # 功能演示 │ └── README.md # 库文档 -├── examples/ # 使用示例 -│ ├── remote_example.sh # 纯远程模式示例 -│ ├── hybrid_loader_template.sh # 混合模式模板 -│ └── REMOTE_LOADER_README.md # 远程加载文档 -└── llmdoc/ # 项目文档系统 - ├── index.md # 文档索引 - ├── overview/ # 项目概览 - ├── guides/ # 使用指南 - ├── architecture/ # 架构文档 - └── reference/ # 参考文档 +└── examples/ # 使用示例 + ├── remote_example.sh # 纯远程模式示例 + ├── hybrid_loader_template.sh # 混合模式模板 + └── REMOTE_LOADER_README.md # 远程加载文档 ``` ## 🚀 快速开始 @@ -268,18 +262,6 @@ retry_command 3 2 "失败" command # 重试执行命令 详细文档:[common/README.md](common/README.md) -## 📖 文档 - -完整的项目文档位于 `llmdoc/` 目录: - -- [llmdoc/index.md](llmdoc/index.md) - 文档索引 -- [llmdoc/overview/project-overview.md](llmdoc/overview/project-overview.md) - 项目概览 -- [llmdoc/guides/getting-started.md](llmdoc/guides/getting-started.md) - 快速开始 -- [llmdoc/guides/common-library-usage.md](llmdoc/guides/common-library-usage.md) - 库使用指南 -- [llmdoc/architecture/common-libraries.md](llmdoc/architecture/common-libraries.md) - 架构设计 -- [llmdoc/reference/coding-conventions.md](llmdoc/reference/coding-conventions.md) - 编码规范 -- [llmdoc/reference/common-library-reference.md](llmdoc/reference/common-library-reference.md) - API 参考 - ## 🔧 开发 ### 编码规范 @@ -292,8 +274,6 @@ retry_command 3 2 "失败" command # 重试执行命令 - **错误处理**:使用 `set -euo pipefail` 严格模式 - **代码风格**:4 空格缩进,ShellCheck 检查 -详见:[llmdoc/reference/coding-conventions.md](llmdoc/reference/coding-conventions.md) - ### 添加新脚本 1. 参考 [examples/hybrid_loader_template.sh](examples/hybrid_loader_template.sh) 创建脚本