参与完善手册
本手册面向使用 G1 EDU 开展研究的读者。贡献内容应帮助读者完成一个具体步骤,并知道如何判断是否成功。优先补充实际验证的命令、设备配置、故障原因和可复现结果。
页面与示例要求
使用页面模板组织前置条件、执行主机、固定版本、操作步骤、预期结果、停止方式、常见失败和官方来源。写明适用机身、末端、相机与固件;有运动的示例必须说明启动/退出行为,不能把演示程序标成只读。
从上游改编代码或图片时保留许可证与出处;自己编写的示意图应标明不代表尺寸或实际端口位置。数值参数、接口和命令尽量链接到固定提交或对应版本文档。原始照片需得到提供者授权并隐藏不宜公开的信息。
内容放在哪里
| 目录 | 内容 |
|---|---|
docs/development/ |
SDK、ROS2、控制与遥操作流程 |
docs/hardware/ |
设备配置、模型、传感器和标定 |
docs/learning/ |
数据、训练、策略和评测 |
docs/maintenance/ |
运维与实验记录 |
examples/ |
可运行脚本、配置与必要测试 |
docs/_static/ |
本地图片、模板、可公开验证产物 |
新增页面同步更新 mkdocs.yml、所属章节导读和相关页面的下一步链接。较长教程按任务拆分,避免重复已有基础说明。根目录的 CONTRIBUTING.md 提供此指南入口。
提交前检查
在仓库根目录、文档虚拟环境中执行:
mkdocs build --strict
python scripts/check_seo.py
python -m unittest discover -s examples/tests -v
git diff --check
代码改动还需运行相应示例:模拟控制验证数值与失败路径,SDK 示例验证类型和只读边界,数据处理检查空数据、缺失图像、单位/维度和时间信息。仅修改文字不需要新增镜像实现的测试。
提交说明应写清问题、最终改变、实际执行的验证及未验证部分。把“无设备无法实测”如实写出,不填写推测的成功率。报告格式见记录模板。