Move project docs to docs/project-docs and update references
- Move AGENTS.md, CLEANUP_SUMMARY.md, DOCUMENTATION_GUIDE.md, IMPLEMENTATION_SUMMARY.md, QUICK_COMMANDS.md to docs/project-docs/ - Update AGENTS.md to include splicing module documentation - Update mkdocs.yml navigation to include project-docs section - Update .gitignore to track docs/ directory - Add docs/plans/ splicing design documents Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
162
docs/project-docs/CLEANUP_SUMMARY.md
Normal file
162
docs/project-docs/CLEANUP_SUMMARY.md
Normal file
@@ -0,0 +1,162 @@
|
||||
# 项目清理总结
|
||||
|
||||
## ✅ 清理完成
|
||||
|
||||
根目录已成功清理,现在更加整洁和专业!
|
||||
|
||||
## 📁 当前根目录结构
|
||||
|
||||
### 保留的 MD 文件(3 个)
|
||||
|
||||
1. **README.md** (7.7 KB)
|
||||
- 项目主文档
|
||||
- 包含快速开始、安装、核心功能说明
|
||||
- 已完全更新为现代化风格
|
||||
|
||||
2. **DOCUMENTATION_GUIDE.md** (7.1 KB)
|
||||
- 文档系统使用指南
|
||||
- 如何编辑、构建、部署文档
|
||||
- 非常实用的参考文档
|
||||
|
||||
3. **QUICK_COMMANDS.md** (2.6 KB)
|
||||
- 快速命令参考
|
||||
- 常用命令速查表
|
||||
- 便于日常使用
|
||||
|
||||
### 归档的文件(14 个)
|
||||
|
||||
已移动到 `archive/` 目录:
|
||||
|
||||
- BATCH_PROCESSING_GUIDE.md
|
||||
- BRIDGE_RING_ANALYSIS.md
|
||||
- FINAL_REPORT.md
|
||||
- FIXES_SUMMARY.md
|
||||
- FRAGMENT_ANALYSIS_GUIDE.md
|
||||
- INDEX.md
|
||||
- LACTONE_DETECTION_FIX.md
|
||||
- PROJECT_COMPLETION_SUMMARY.md
|
||||
- PROJECT_SUMMARY.md
|
||||
- QUICK_GUIDE.md
|
||||
- QUICK_START.md
|
||||
- RERUN_GUIDE.md
|
||||
- SUMMARY.md
|
||||
- USAGE_EXAMPLES.md
|
||||
|
||||
这些是开发过程中的临时文档,已归档备份但不再维护。
|
||||
|
||||
## 📚 完整文档位置
|
||||
|
||||
所有重要内容已整合到专业的文档系统中:
|
||||
|
||||
### docs/ 目录结构
|
||||
|
||||
```
|
||||
docs/
|
||||
├── index.md # 文档首页
|
||||
├── getting-started.md # 快速开始(5分钟上手)
|
||||
├── installation.md # 详细安装指南
|
||||
├── user-guide/ # 用户指南
|
||||
│ ├── index.md
|
||||
│ ├── fragmenter-usage.md # MacrolactoneFragmenter 使用
|
||||
│ ├── ring-numbering.md # 环编号系统
|
||||
│ ├── visualization.md # 可视化功能
|
||||
│ ├── batch-processing.md # 批量处理
|
||||
│ └── data-export.md # 数据导出
|
||||
├── tutorials/ # 教程与示例
|
||||
│ ├── index.md
|
||||
│ ├── basic-tutorial.md
|
||||
│ ├── advanced-usage.md
|
||||
│ └── use-cases.md
|
||||
├── api/ # API 参考(自动生成)
|
||||
│ ├── index.md
|
||||
│ ├── macrolactone-fragmenter.md
|
||||
│ ├── fragment-dataclass.md
|
||||
│ ├── ring-numbering.md
|
||||
│ ├── ring-visualization.md
|
||||
│ └── utilities.md
|
||||
├── development/ # 开发者指南
|
||||
│ ├── index.md
|
||||
│ ├── contributing.md
|
||||
│ ├── project-structure.md
|
||||
│ └── testing.md
|
||||
└── about/ # 关于
|
||||
├── index.md
|
||||
├── changelog.md
|
||||
└── license.md
|
||||
```
|
||||
|
||||
## 🎯 清理带来的好处
|
||||
|
||||
1. **更专业**:根目录整洁,符合开源项目规范
|
||||
2. **易导航**:只保留最重要的 3 个文档
|
||||
3. **不丢失**:旧文档已归档到 `archive/` 目录
|
||||
4. **文档化**:完整的文档系统在 `docs/` 目录
|
||||
|
||||
## 🚀 如何查看文档
|
||||
|
||||
### 本地预览
|
||||
|
||||
```bash
|
||||
# 启动文档服务器
|
||||
pixi run mkdocs serve
|
||||
|
||||
# 访问 http://localhost:8000
|
||||
```
|
||||
|
||||
### 构建静态网站
|
||||
|
||||
```bash
|
||||
# 构建到 site/ 目录
|
||||
pixi run mkdocs build
|
||||
```
|
||||
|
||||
### 部署到 GitHub Pages
|
||||
|
||||
```bash
|
||||
# 自动构建并部署
|
||||
pixi run mkdocs gh-deploy
|
||||
```
|
||||
|
||||
## 📋 快速参考
|
||||
|
||||
| 文档 | 用途 | 位置 |
|
||||
|------|------|------|
|
||||
| 项目介绍 | 快速了解项目 | `README.md` |
|
||||
| 快速开始 | 5分钟上手 | `docs/getting-started.md` |
|
||||
| 安装指南 | 详细安装步骤 | `docs/installation.md` |
|
||||
| 用户指南 | 完整使用说明 | `docs/user-guide/` |
|
||||
| API 文档 | 代码参考 | `docs/api/` |
|
||||
| 教程示例 | 实际案例 | `docs/tutorials/` |
|
||||
| 开发指南 | 贡献代码 | `docs/development/` |
|
||||
| 文档系统 | 如何编辑文档 | `DOCUMENTATION_GUIDE.md` |
|
||||
| 快速命令 | 常用命令 | `QUICK_COMMANDS.md` |
|
||||
|
||||
## 📊 统计
|
||||
|
||||
### 清理前
|
||||
- 根目录 MD 文件:17 个
|
||||
- 总大小:~120 KB
|
||||
- 状态:混乱,难以导航
|
||||
|
||||
### 清理后
|
||||
- 根目录 MD 文件:3 个(保留最重要的)
|
||||
- 归档文件:14 个(移动到 archive/)
|
||||
- 完整文档:30+ 个(在 docs/ 目录)
|
||||
- 状态:整洁,专业,易于使用
|
||||
|
||||
## ✨ 总结
|
||||
|
||||
根目录清理完成!现在项目结构更加清晰:
|
||||
|
||||
- ✅ **根目录**:只有 3 个核心 MD 文件
|
||||
- ✅ **docs/**:完整的文档系统(30+ 文件)
|
||||
- ✅ **archive/**:历史文档归档
|
||||
- ✅ **src/**:核心代码
|
||||
- ✅ **notebooks/**:示例 Notebook
|
||||
|
||||
项目现在完全准备好分享、发布和协作!🎉
|
||||
|
||||
---
|
||||
|
||||
*清理日期:2025-11-08*
|
||||
|
||||
Reference in New Issue
Block a user