-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
First attempt at a docs style guide (#1062)
- Loading branch information
Showing
1 changed file
with
14 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Documentation Style Guide | ||
|
||
## Do's | ||
|
||
- Submit documentation formatted in [Markdown](https://en.wikipedia.org/wiki/Markdown) format. | ||
-- Please add Markdown headings to the content sections. | ||
- Use a Github Pull Request to submit documentation. | ||
- Use the "bold/emphasis" style in Markdown for UI elements that users will interact with. For example, a button label for a button that must be pressed should be made bold in Markdown. | ||
- Use the "italics" style in Markdown for UI elements that have a label or title if you need to reference them in the documentation. For example, a title of a screen or page that will visit should be made italic in Markdown. | ||
|
||
## Don'ts | ||
|
||
- Do not leave any "trailing spaces" at the end of lines of content. | ||
- Do not use "curly" quotes and apostrophes, use only "straight" quotes and apostrophes. |