114 lines
3.3 KiB
Markdown
114 lines
3.3 KiB
Markdown
# ARTv2 文档索引
|
||
|
||
## 📚 文档结构
|
||
|
||
本目录包含 ARTv2 插件的所有技术文档。
|
||
|
||
---
|
||
|
||
## 🎯 核心文档（必读）
|
||
|
||
### 1. [PROJECT_STATUS.md](PROJECT_STATUS.md) - 项目状态总览
|
||
**最重要的文档** - 包含：
|
||
- 当前项目状态：✅ 可用于生产环境
|
||
- Python 3 迁移完成情况：✅ 100% 完成（53个模块）
|
||
- 代码质量状态：✅ 已修复 50 个问题
|
||
- 已知问题和修复：3 个严重错误已全部修复
|
||
- 下一步计划
|
||
|
||
### 2. [QUICK_REFERENCE.md](QUICK_REFERENCE.md) - 快速参考
|
||
- ARTv2 使用指南
|
||
- 常见问题解答
|
||
- 工作流程说明
|
||
|
||
---
|
||
|
||
## 🔧 技术文档
|
||
|
||
### 3. [TECHNICAL_DETAILS.md](TECHNICAL_DETAILS.md) - 技术细节
|
||
合并了以下内容：
|
||
- Python 3 迁移技术细节
|
||
- 代码架构说明
|
||
- 关键技术实现
|
||
- 性能优化建议
|
||
|
||
### 4. [IMPROVEMENTS.md](IMPROVEMENTS.md) - 改进记录
|
||
记录了所有实现的改进：
|
||
- 模块构建错误恢复
|
||
- 安全骨骼删除检查
|
||
- 权重导入错误处理
|
||
- 预检查机制
|
||
|
||
### 5. [WORKFLOW_VERIFICATION.md](WORKFLOW_VERIFICATION.md) - 工作流程验证
|
||
**重要** - 对照官方文档的完整验证：
|
||
- 模块创建流程验证
|
||
- 骨骼构建流程验证
|
||
- 绑定构建流程验证
|
||
- 权重管理流程验证
|
||
- 发布流程验证
|
||
- 测试检查清单
|
||
|
||
---
|
||
|
||
## 📊 历史记录（参考）
|
||
|
||
### 6. [CHANGELOG.md](CHANGELOG.md) - 变更日志
|
||
- 所有代码修复记录
|
||
- 版本更新历史
|
||
- 重要变更说明
|
||
|
||
---
|
||
|
||
## 🗑️ 已归档文档
|
||
|
||
以下文档已合并到核心文档中，不再单独维护：
|
||
|
||
- ~~BUILD_PROCESS_ANALYSIS.md~~ → 合并到 TECHNICAL_DETAILS.md
|
||
- ~~CODE_QUALITY_ISSUES.md~~ → 合并到 PROJECT_STATUS.md
|
||
- ~~COMPATIBILITY_REPORT.md~~ → 合并到 PROJECT_STATUS.md
|
||
- ~~COMPLETE_CODE_STYLE_SCAN.md~~ → 合并到 CHANGELOG.md
|
||
- ~~ERROR_ANALYSIS.md~~ → 合并到 CHANGELOG.md
|
||
- ~~FINAL_STATUS_REPORT.md~~ → 合并到 PROJECT_STATUS.md
|
||
- ~~FIX_REPORT.md~~ → 合并到 CHANGELOG.md
|
||
- ~~IMPROVEMENTS_IMPLEMENTED.md~~ → 合并到 IMPROVEMENTS.md
|
||
- ~~NEXTSTEP.md~~ → 合并到 PROJECT_STATUS.md
|
||
- ~~PLANGOAL.md~~ → 合并到 PROJECT_STATUS.md
|
||
- ~~PYTHON3_MIGRATION_ANALYSIS.md~~ → 合并到 TECHNICAL_DETAILS.md
|
||
- ~~ROADMAP.md~~ → 合并到 PROJECT_STATUS.md
|
||
- ~~TECHNICAL_IMPLEMENTATION.md~~ → 合并到 TECHNICAL_DETAILS.md
|
||
- ~~TECHNICAL_PIPELINE.md~~ → 合并到 TECHNICAL_DETAILS.md
|
||
|
||
---
|
||
|
||
## 📖 阅读建议
|
||
|
||
### 新用户
|
||
1. 阅读 [QUICK_REFERENCE.md](QUICK_REFERENCE.md)
|
||
2. 查看 [PROJECT_STATUS.md](PROJECT_STATUS.md) 了解当前状态
|
||
|
||
### 开发者
|
||
1. 阅读 [PROJECT_STATUS.md](PROJECT_STATUS.md)
|
||
2. 查看 [WORKFLOW_VERIFICATION.md](WORKFLOW_VERIFICATION.md)
|
||
3. 查看 [TECHNICAL_DETAILS.md](TECHNICAL_DETAILS.md)
|
||
4. 参考 [IMPROVEMENTS.md](IMPROVEMENTS.md)
|
||
|
||
### 维护者
|
||
1. 查看 [PROJECT_STATUS.md](PROJECT_STATUS.md) 了解待办事项
|
||
2. 阅读 [CHANGELOG.md](CHANGELOG.md) 了解历史变更
|
||
3. 参考 [TECHNICAL_DETAILS.md](TECHNICAL_DETAILS.md) 进行开发
|
||
|
||
---
|
||
|
||
## 🔄 文档更新规则
|
||
|
||
- **PROJECT_STATUS.md**: 每次重要变更后更新
|
||
- **CHANGELOG.md**: 每次代码修复后添加记录
|
||
- **TECHNICAL_DETAILS.md**: 发现新技术细节时更新
|
||
- **IMPROVEMENTS.md**: 实现新功能后记录
|
||
- **QUICK_REFERENCE.md**: 用户反馈后优化
|
||
|
||
---
|
||
|
||
**最后更新**: 2024-12-07
|
||
**文档版本**: 2.0（精简版）
|