Skip to content

Commit

Permalink
First attempt at a docs style guide (#1062)
Browse files Browse the repository at this point in the history
  • Loading branch information
ysuarez authored and mjordan committed Mar 21, 2019
1 parent c4cbab2 commit 642e712
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/technical-documentation/docs_style_guide.md
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.

0 comments on commit 642e712

Please sign in to comment.