22. 附录 C: 更新日志

本文档记录 SimKit 文档的更新历史。

22.1. 当前构建

  • Sphinx 构建时间:|today|


22.2. 2026-04-21: 文档架构重构

22.2.1. 变更内容

  • 重构文档架构为 4 章 + 6 附录

  • 新增快速安装章节 (1 页)

  • 新增主要功能章节

  • 迁移架构设计到独立章节

  • 整合模块介绍

  • API 手册移至附录 A

  • 详细安装指南移至附录 B

22.2.2. 文件调整

新增:

  • 01-quick-install.md

  • 02-features.md

  • 03-architecture.md

  • 04-modules.md

  • appendix-a-api.md

  • appendix-b-install.md

  • appendix-c-changelog.md

删除:

  • quickstart.md (内容迁移)

  • guides/architecture.md (内容迁移)

  • update_log.md (内容迁移)


22.3. 2026-04-16: 架构文档大修

22.3.1. 新增内容

  • guides/architecture.md - 完整架构概述

    • 项目愿景和设计目标

    • 分层架构图

    • 仿真器无关 vs 仿真器相关模块分类

    • 三种仿真器集成方法

    • 数据流图

    • 核心应用场景

    • 新仿真器扩展指南

    • 路线图 (短/中/长期)

22.3.2. 更新内容

  • index.md - 重新设计首页

    • 中文语言提高可访问性

    • 架构概述图

    • 模块状态表

    • 核心应用场景

    • 快速导航链接


22.4. 2026-04-16 (晚): 端到端任务流程

22.4.1. 新增章节

  1. 端到端算法测试

    • 完整测试流程 (6 步)

    • 任务类型:抓取生成、运动规划、RL 训练、视觉感知、任务规划

    • 代码示例:GraspNet 基准、PPO 训练

    • 并行和分布式测试

  2. 数据生成流程

    • 支持的数据类型

    • 7 步流程

    • 大规模生成

    • COCO 格式输出

  3. 最佳实践

    • 算法测试:多种子评估、场景覆盖、基线对比

    • 数据生成:多样性、域随机化、质量检查


22.5. 2026-04-16 (晚): 系统评估指标

22.5.1. 新增章节

  1. 任务支持能力

    • 6 个任务类别

    • 场景复杂度支持

    • 任务覆盖率公式

  2. 数据生成能力

    • 吞吐量指标:60 FPS (单 GPU) 到 800 FPS (64 GPU)


22.6. 验证

uv run sphinx-build -b html docs-src docs-build