Skip to content
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

First attempt at a docs style guide #1062

Merged
merged 1 commit into from
Mar 21, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, nice. When you copy paste curly quotes into a terminal the command won't run and then you have to go fix them 💩