moyin
0edd1c740b
- 修复README.md中的emoji字符显示问题 - 移除文档质量评级系统 - 添加贡献者致谢部分，创建详细的CONTRIBUTORS.md - 创建核心系统文件EventNames.gd和ProjectPaths.gd - 更新项目配置文件project.godot，添加输入映射 - 完善各模块文档，修正路径引用问题 - 创建文档更新日志CHANGELOG.md - 优化文档结构和导航系统
2.5 KiB
2.5 KiB
文档更新日志
本文档记录了WhaleTown项目文档的重要更新和修改。
版本 1.1.0 (2025-12-31)
🆕 新增内容
- 新增:
_Core/EventNames.gd- 统一管理所有事件名称常量 - 新增:
_Core/ProjectPaths.gd- 统一管理项目路径配置 - 新增: 输入映射配置到
project.godot - 新增: 文档更新日志
docs/CHANGELOG.md
🔧 修复问题
- 修复: 架构与通信规范中AutoLoad单例数量描述（从3个更新为5个）
- 修复: 网络管理器设置文档中的路径错误（
core/→_Core/） - 修复: Web部署指南中的资源路径（
assets/web/→web_assets/） - 修复: 场景设计规范中的目录结构（
prefabs/→Components/） - 修复: 性能优化指南中的预制体路径
- 修复: 模块开发指南中的测试基类路径（使用
GutTest而非完整路径）
📝 内容优化
- 优化: 场景命名规范，与实际项目结构保持一致
- 优化: 所有文档中的路径引用，使用
ProjectPaths统一管理 - 优化: 代码示例的准确性和可用性
🎯 质量提升
- 提升: 文档与实际代码的匹配度
- 提升: 路径配置的一致性和可维护性
- 提升: 开发者体验和文档可用性
版本 1.0.0 (2025-12-24)
📚 初始文档结构
- 01-项目入门: 项目介绍、结构说明、设置指南
- 02-开发规范: 命名规范、注释规范、Git提交规范、架构规范、开发哲学
- 03-技术实现: 实现细节、API文档、网络管理器、测试指南
- 04-高级开发: 场景设计、模块开发、性能优化
- 05-部署运维: Web部署指南
- 06-功能模块: 认证模块相关文档
🏗️ 核心特性
- 完整的开发规范体系
- 详细的技术实现指导
- 全面的测试和部署流程
- 模块化的功能开发指南
维护说明
文档更新原则
- 同步更新: 代码变更时同步更新相关文档
- 版本记录: 重要更新需要在此日志中记录
- 向后兼容: 尽量保持API和配置的向后兼容性
- 质量保证: 确保文档内容的准确性和可用性
贡献指南
- 发现文档问题请及时反馈
- 提交文档更新时请更新此日志
- 重大变更需要团队讨论确认