Repository navigation
Conversation
| sidebar_position: 3 | ||
| --- | ||
|
|
||
| # Vale demo — intentional style issues |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Dashes] Remove the spaces around ' — '.
| # Vale demo — intentional style issues | ||
|
|
||
| This page exists **only to trigger Vale** on a pull request or when you run | ||
| `vale docs` locally. Do not use this wording in real documentation. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'don't' instead of 'Do not'.
|
|
||
| ## Getting started (bad example) | ||
|
|
||
| In order to deploy the application, you will need to simply click here and |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'to' instead of 'In order to'.
|
|
||
| ## Getting started (bad example) | ||
|
|
||
| In order to deploy the application, you will need to simply click here and |
There was a problem hiding this comment.
[write-good.TooWordy] 'In order to' is too wordy.
| ## Getting started (bad example) | ||
|
|
||
| In order to deploy the application, you will need to simply click here and | ||
| follow the steps. It's very easy to get started — we're sure you'll love it!!! |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'It's'.
|
|
||
| ## Things to avoid in real docs | ||
|
|
||
| Just remember that you can basically always use shorter sentences. There are |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[write-good.ThereIs] Don't start a sentence with 'There are'.
|
|
||
| ## Things to avoid in real docs | ||
|
|
||
| Just remember that you can basically always use shorter sentences. There are |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).
|
|
||
| ## Things to avoid in real docs | ||
|
|
||
| Just remember that you can basically always use shorter sentences. There are |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'are'.
| ## Things to avoid in real docs | ||
|
|
||
| Just remember that you can basically always use shorter sentences. There are | ||
| many different ways to say the same thing, and it's important to note that |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'it's'.
|
|
||
| Just remember that you can basically always use shorter sentences. There are | ||
| many different ways to say the same thing, and it's important to note that | ||
| readers will easily get confused if you use weasel words and passive voice |
There was a problem hiding this comment.
[Microsoft.Adverbs] Remove 'easily' if it's not important to the meaning of the statement.
No description provided.