Skip to content

文档:说明项目文档贡献计划 - #41

Open
wangxin926402 wants to merge 1 commit into
OpenHUTB:masterfrom
wangxin926402:patch-2
Open

wangxin926402 wants to merge 1 commit into
OpenHUTB:masterfrom
wangxin926402:patch-2

Conversation

@wangxin926402

Copy link
Copy Markdown
Contributor

关联 #22。

本 PR 为文档仓库 README 增加面向贡献者的改进方向和提交前核对方法,覆盖构建、API 与传感器示例、HUTB/ROS/PX4 集成及 MkDocs 导航。内容依据现有目录和贡献指南编写,没有设置未经确认的时间表。

关联 OpenHUTB#22

围绕构建环境、API 与传感器示例、仿真器集成及 MkDocs 导航列出可持续补充的方向,并明确提交前的本地预览和 issue/PR 信息要求。
Comment thread README.md

提交前可在仓库根目录安装 requirements.txt 中的依赖并运行 `mkdocs serve --livereload`,检查页面能否生成、链接是否有效。涉及构建或接口行为时,请在 issue 中记录分支、操作系统和复现步骤,并在 PR 中说明实际核对的平台或运行方式;未经实测的示例应明确标注。

详见 [贡献指南](CONTRIBUTING.md)。

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

该文件不存在

Comment thread README.md

本仓库介绍低空载具仿真,是人车模拟器文档的一部分。欢迎围绕可复现的使用问题持续补充说明,适合优先处理的方向包括:

- **构建与环境:**按操作系统、模拟器分支和 Python 版本记录前置条件及构建命令,避免把不同版本的步骤混写。

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

加粗渲染失败

Image

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants