docs: add quick start guide #26
Merged
Conversation
This file contains hidden or 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
froschdesign
reviewed
Apr 2, 2021
froschdesign
requested changes
Apr 2, 2021
There was a problem hiding this comment.
For headlines the Chicago Manual of Style capitalization rules must be used:
- Capitalize the first and the last word.
- Capitalize nouns, pronouns, adjectives, verbs, adverbs, and subordinate conjunctions.
- Lowercase articles (a, an, the), coordinating conjunctions, and prepositions.
- Lowercase the ‘to’ in an infinitive (I want to play guitar).
The online tool capitalizemytitle.com can help to capitalize and case convert the headlines.
boesing
force-pushed
the
documentation/quick-start-guide
branch
2 times, most recently
from
68d7c67 to
fd3d47b
Compare
Signed-off-by: Maximilian Bösing <[email protected]>
boesing
force-pushed
the
documentation/quick-start-guide
branch
from
fd3d47b to
f8f56d2
Compare
froschdesign
approved these changes
Apr 2, 2021
|
@froschdesign I wonder if its somehow possible to verify the Chicago Manual of Style rule with the markdown linter somehow. |
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.
Description
Adding a Quick Start Guide to help users to have an idea on how to use this component in their project(s).