Skip to content

Add Vale demo page with intentional style issues - #1

Open
kenrao wants to merge 1 commit into
mainfrom
vale-demo-test
Open

kenrao wants to merge 1 commit into
mainfrom
vale-demo-test

Conversation

@kenrao

@kenrao kenrao commented May 25, 2026

Copy link
Copy Markdown
Owner

No description provided.

Comment thread docs/vale-demo.mdx
sidebar_position: 3
---

# Vale demo — intentional style issues

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Dashes] Remove the spaces around ' — '.

Comment thread docs/vale-demo.mdx
# 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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'don't' instead of 'Do not'.

Comment thread docs/vale-demo.mdx

## Getting started (bad example)

In order to deploy the application, you will need to simply click here and

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'to' instead of 'In order to'.

Comment thread docs/vale-demo.mdx

## Getting started (bad example)

In order to deploy the application, you will need to simply click here and

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[write-good.TooWordy] 'In order to' is too wordy.

Comment thread docs/vale-demo.mdx
## 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!!!

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'It's'.

Comment thread docs/vale-demo.mdx

## Things to avoid in real docs

Just remember that you can basically always use shorter sentences. There are

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[write-good.ThereIs] Don't start a sentence with 'There are'.

Comment thread docs/vale-demo.mdx

## Things to avoid in real docs

Just remember that you can basically always use shorter sentences. There are

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).

Comment thread docs/vale-demo.mdx

## Things to avoid in real docs

Just remember that you can basically always use shorter sentences. There are

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'are'.

Comment thread docs/vale-demo.mdx
## 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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'it's'.

Comment thread docs/vale-demo.mdx

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Microsoft.Adverbs] Remove 'easily' if it's not important to the meaning of the statement.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants