First attempt at a docs style guide #1062
Merged
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
dannylamb
reviewed
Mar 15, 2019
| ## 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. |
There was a problem hiding this comment.
Yeah, nice. When you copy paste curly quotes into a terminal the command won't run and then you have to go fix them 💩
manez
approved these changes
Mar 18, 2019
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.
GitHub Issue: #1040
What does this Pull Request do?
Creates docs/technical-documentation/docs_style_guide.md as a place to have a documentation style guide.
What's new?
A draft version of a documentation style guide based on simple suggestions I once got from @whikloj
How should this be tested?
Review to see what corrections or additions should be made to the content.
Interested parties
@Islandora-CLAW/committers