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

Adds Note to Good to know consistency #51080

Merged
merged 10 commits into from
Jun 13, 2023
14 changes: 11 additions & 3 deletions docs/05-community/01-contribution-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -286,19 +286,27 @@ We do not use emojis in the docs.

## Notes

For information that is important but not critical, use a note. Notes are a good way to add information without distracting the user from the main content.
For information that is important but not critical, use notes. Notes are a good way to add information without distracting the user from the main content.

We use two different styles.

```mdx filename="notes.mdx"
> **Note**: This is a single line note.

> **Good to know**:
>
> This is a note :)
> - We use these to call out something worth knowing or keeping in mind.
> - We also use this format for multi-line notes.
```

**Output:**

> **Note**: This is a single line note.

> **Good to know**:
>
> This is a note :)
> - We use these to call out item worth knowing or keeping in mind.
> - We also use this format for multi-line notes.

## Related Links

Expand Down