docs: 从 README 中移除 llmdoc 相关内容

## 修改原因

llmdoc/ 目录已在 .gitignore 中被忽略,不应在 README 中引用。

## 变更内容

### 移除的章节

1. **项目结构**:移除 llmdoc/ 目录及其子目录说明
2. **📖 文档**:移除整个文档章节(包含 7 个 llmdoc 链接)
3. **编码规范**:移除指向 llmdoc/reference/coding-conventions.md 的链接

### 保留的内容

-  公共库文档链接(common/README.md)
-  远程加载文档链接(examples/REMOTE_LOADER_README.md)
-  所有其他功能和使用说明

## 影响

- 文档更加简洁,只包含版本控制中的内容
- 用户可通过 common/ 和 examples/ 目录中的文档获取详细信息
- 与 .gitignore 配置保持一致
This commit is contained in:
2025-12-26 15:04:57 +08:00
parent f6d9274306
commit 71d487c59a

View File

@@ -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) 创建脚本