Documentation guidelines #4
Open
Conversation
This file contains 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
jaxxzer
requested review from
rjehangir,
patrickelectric,
Williangalvani and
kklemens
patrickelectric
requested changes
Apr 2, 2019
| - General ArduSub firmware documentation and instructions | ||
| - Blue Robotics companion documentation | ||
| - QGC + ArduSub + companion integration and usage instructions | ||
| - Developer examples for interacting with ArduSub via MAVLink/MAVProxy |
There was a problem hiding this comment.
Add hyperlink for ardusub-gitbook repository
| - [ArduPilot wiki](http://ardupilot.org/ardupilot/) | ||
| This [repository](https://github.com/ArduPilot/ardupilot_wiki) is owned and maintained by the ardupilot organization. It contains documentation for ardupilot generally, as well as documentation for the other ardupilot vehicles (copter, plane, rover, but not ArduSub). | ||
| - [QGroundControl gitbook](https://docs.qgroundcontrol.com/en/) | ||
| This repository is owned and maintained by the mavlink organization. It is the official documentation for QGroundControl users. This is where documenation on QGroundControl usage should generally go. |
|
|
||
| - Repository READMEs | ||
|
|
||
| Each repository should have a README in the root directory. This README is displayed on the project's home page. The README should contain information about what the project does, how to install it, and how to use it. CI status information should be added to the top of the README. Additional READMEs may exist in project subdirectories, which will be displayed when the directory is opened in github. |
There was a problem hiding this comment.
Link for the documentation/wiki/store if it exists.
|
|
||
| If the product is related to one or more software projects, the product *Learn* tab should link out to the software documentation. | ||
|
|
||
| - This repository |
There was a problem hiding this comment.
This should be in the main README of this repository, or something with the same description.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.