docs: Standardize "Note" blockquote usage #11724
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
cla-bot
bot
added
the
cla-signed
maxdeviant
approved these changes
May 13, 2024
osiewicz
pushed a commit
to RemcoSmitsDev/zed
that referenced
this pull request
May 18, 2024
Standardize the blockquote "Notes" usage, so all places are using the `>` blockquote notation, as well as a consistent style for the "Note" word. PS: Thought that bolding the word "**Note**" would make for a higher visual distinction, so went for it in all existing cases! No strong feelings, though; happy to roll back to just "Note:" if that's preferrable! Release Notes: - N/A
SomeoneToIgnore
pushed a commit
that referenced
this pull request
May 25, 2024
Mostly tiny stuff. Quick run-down of the changes: - Using `*Note*` instead of `NOTE` for the blockquote callouts (piggybacking from #11724) - Use hyphens for bullet lists instead of asterisks - Capitalize every (applicable) mention to Zed - Capitalize mentions of other products (e.g., google cloud → Google Cloud) - Swap e.g. → for example — for clarity (latinisms may be unfamiliar for some non-native English speakers, surprisingly!) Release Notes: N/A
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.
Standardize the blockquote "Notes" usage, so all places are using the
>blockquote notation, as well as a consistent style for the "Note" word.PS: Thought that bolding the word "Note" would make for a higher visual distinction, so went for it in all existing cases! No strong feelings, though; happy to roll back to just "Note:" if that's preferrable!
Release Notes: