|
|
71d487c59a
|
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 配置保持一致
|
2025-12-26 15:04:57 +08:00 |
|
|
|
f6d9274306
|
docs: 添加项目主 README 文档
## 新增内容
添加项目根目录 README.md，提供完整的项目介绍和使用指南。
## 文档内容
### 核心章节
1. **项目简介**: 概述项目目标和核心特性
2. **项目结构**: 清晰的目录树和模块说明
3. **快速开始**: 三种使用模式的快速指南
4. **功能模块**: 详细的工具功能和使用示例
5. **远程库加载**: 智能加载机制说明
6. **公共库**: logging.sh 和 error_handler.sh 使用方法
7. **文档导航**: llmdoc 文档系统链接
8. **开发指南**: 编码规范和贡献流程
### 特色内容
- ✅ Shields.io 徽章（版本、Shell、许可证）
- ✅ Emoji 图标增强可读性
- ✅ 代码示例和命令行演示
- ✅ 环境变量配置表格
- ✅ 完整的使用场景覆盖
- ✅ 内部文档交叉引用
- ✅ 版本更新日志
### 使用场景
- 📖 新用户快速了解项目
- 🚀 快速开始使用工具
- 📚 查找功能和使用方法
- 🔗 导航到详细文档
|
2025-12-26 15:02:30 +08:00 |
|
|
|
b34e1ef872
|
feat: 为所有脚本添加远程库加载支持
## 功能概述
实现了智能远程库加载机制，允许脚本从远程 Gitea 仓库动态下载公共库，
同时保留本地库优先的策略，确保脚本可以独立运行而不依赖本地项目结构。
## 变更内容
### 新增文件
- **common/remote_loader.sh**: 核心远程加载器
- 支持 curl/wget 双重下载方式
- 临时文件自动清理机制
- 环境变量可配置仓库 URL
- **examples/remote_example.sh**: 纯远程模式示例
- 演示完全独立的远程加载脚本
- 适合单文件分发场景
- **examples/hybrid_loader_template.sh**: 混合模式模板
- 本地优先 + 远程回退策略
- 适合仓库内脚本
- **examples/REMOTE_LOADER_README.md**: 完整使用文档
- 三种使用模式详解
- 故障排除指南
- 最佳实践建议
### 更新脚本（版本 2.1.0）
所有主要脚本均升级到 2.1.0 版本，支持智能库加载：
- **linux/create_raid0_array.sh**
- **linux/repartition_disks.sh**
- **linux/install_oh_my_zsh.sh**
- **gcp/create_ai_projects.sh**
- **gcp/delete_all_projects.sh**
- **oci/create_instance.sh**
- **common/demo_usage.sh**
## 加载策略
1. 检查 FORCE_REMOTE=1 环境变量 → 强制远程
2. 检查本地库存在性 → 优先使用本地
3. 本地不存在 → 自动回退远程
4. 远程失败 → 友好错误提示
## 使用示例
### 本地模式（默认）
```bash
./linux/create_raid0_array.sh
```
### 强制远程模式
```bash
FORCE_REMOTE=1 ./linux/create_raid0_array.sh
```
### 自定义仓库 URL
```bash
REMOTE_LIB_URL=https://example.com/repo ./script.sh
```
## 技术特性
- ✅ 向后兼容：默认使用本地库，行为不变
- ✅ 离线可用：本地库存在时无需网络
- ✅ 独立分发：支持单文件脚本分发
- ✅ 错误处理：详细的错误信息和诊断建议
- ✅ 环境可配：REMOTE_LIB_URL 和 FORCE_REMOTE
- ✅ 自动清理：临时文件通过 trap 自动删除
|
2025-12-26 15:00:06 +08:00 |
|
|
|
7def817482
|
feat: 代码标准化和文件重命名
## 新增功能
- 创建统一的公共函数库 (common/logging.sh, common/error_handler.sh)
- 添加功能演示脚本 (common/demo_usage.sh)
- 完善的使用文档 (common/README.md)
## 代码重构
- 重构所有脚本使用统一的公共库
- 为所有函数添加完整的文档注释
- 统一代码格式（4空格缩进、严格模式）
- 标准化错误处理和日志输出
## 文件重命名
- gcp/create_ai_project.sh → gcp/create_ai_projects.sh (单复数统一)
- gcp/delete_all_project.sh → gcp/delete_all_projects.sh (单复数统一)
- linux/install_ohmyzsh.sh → linux/install_oh_my_zsh.sh (专有名词规范)
- linux/create_raid0_with_ext4.sh → linux/create_raid0_array.sh (简化命名)
- common/example.sh → common/demo_usage.sh (更具描述性)
## 技术改进
- 使用 readonly 声明常量
- 启用 set -euo pipefail 严格模式
- 统一的 ANSI 颜色日志输出
- 完善的命令重试机制
- 栈追踪支持
|
2025-12-26 14:47:18 +08:00 |
|
