Mirrors_Framework/PX4-Autopilot
1
0
Fork 0
mirror of https://github.com/PX4/PX4-Autopilot.git synced 2026-10-06 09:02:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update contribution guidelines for content formatting (#28389)

Browse Source 
Clarified guidelines for content formatting and line breaks.
This commit is contained in:
Hamish Willee
2026-08-26 16:27:39 +10:00
committed by GitHub
parent abacf664cb
commit 1340559f07
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/contribute/docs.md
+3 -2
View File
@@ -286,6 +286,7 @@ When you add a new page you must also add it to `en/SUMMARY.md`!
PNG files are preferred over JPG for screenshots.
3. Content:
- Follow British English (UK) conventions for spelling and grammar, with the exception of industry-standard software terminology (e.g., dialog, program, disk).
- Use "style" (**bold**, _emphasis_, etc.) consistently and sparingly (as little as possible).
- **Bold** for button presses and menu definitions.
- _Emphasis_ for tool names such as _QGroundControl_ or _prettier_.
@@ -295,8 +296,8 @@ When you add a new page you must also add it to `en/SUMMARY.md`!
All other headings should be h2 (`##`) or lower.
- Don't add any style to headings.
- Don't translate the text indicating the name of an `info`, `tip` or `warning` declaration (e.g. `::: tip`) as this precise text is required to render the aside properly.
- Break lines on sentences by preference.
Don't break lines based on some arbitrary line length.
- Don't break lines based on some arbitrary line length.
Break line breaks on sentences (or paragraphs).
- Format using _prettier_ (_VSCode_ is a has extensions can be used for this).
4. Videos: