Repository navigation
文档:说明项目文档贡献计划 #41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
wangxin926402
wants to merge
1
commit into
OpenHUTB:master
Choose a base branch
from
wangxin926402:patch-2
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
文档:说明项目文档贡献计划 #41
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,19 @@ mkdocs serve --livereload | |
| 详细部署方案请参考 [人车模拟器文档](https://github.com/OpenHUTB/doc) 。 | ||
|
|
||
|
|
||
| ## 文档贡献方向与计划 | ||
|
|
||
| 本仓库介绍低空载具仿真,是人车模拟器文档的一部分。欢迎围绕可复现的使用问题持续补充说明,适合优先处理的方向包括: | ||
|
|
||
| - **构建与环境:**按操作系统、模拟器分支和 Python 版本记录前置条件及构建命令,避免把不同版本的步骤混写。 | ||
| - **API 与传感器示例:**补充可运行的最小示例,并注明所需的模拟器模式、载具和预期输出。 | ||
| - **集成工作流:**完善 AirSim 与 ROS、PX4/ArduPilot、HUTB 的连接说明,保持本仓库与主文档之间的入口一致。 | ||
| - **导航与链接:**将新增页面加入 mkdocs.yml 的对应目录,并确认相关页面之间可以互相到达。 | ||
|
|
||
| 提交前可在仓库根目录安装 requirements.txt 中的依赖并运行 `mkdocs serve --livereload`,检查页面能否生成、链接是否有效。涉及构建或接口行为时,请在 issue 中记录分支、操作系统和复现步骤,并在 PR 中说明实际核对的平台或运行方式;未经实测的示例应明确标注。 | ||
|
|
||
| 详见 [贡献指南](CONTRIBUTING.md)。 | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 该文件不存在 |
||
|
|
||
| ### 其他问题和解决方案 | ||
|
|
||
| ##### Codespace运行报错:ERROR: No matching distribution found for pymdownx | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
加粗渲染失败