Add BLOG_STYLE_GUIDE.md #2032
Open
Add BLOG_STYLE_GUIDE.md #2032
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
|
@martinbonnin is attempting to deploy a commit to the The GraphQL Foundation Team on Vercel. A member of the Team first needs to authorize it. |
benjie
requested changes
Jun 23, 2025
BLOG_STYLE_GUIDE.md
Outdated
| ### Introduction | ||
|
|
||
| - Hook the reader in 1–2 sentences. | ||
| - Set clear expectations about what the post covers and who it's for. |
There was a problem hiding this comment.
This sentence might be a better way of addressing the "audience first" bullet from the top.
There was a problem hiding this comment.
I shuffled things a bit here
BLOG_STYLE_GUIDE.md
Outdated
| - Overuse of metaphors. Use them sparingly to aid understanding. | ||
| - Outdated examples or deprecated syntax. | ||
| - Avoid passive voice when possible. | ||
| - Avoid future tense. |
There was a problem hiding this comment.
The title makes this read as:
"Don't... avoid future tense"
Should rework this section a little. Or prefix every bullet with Don't for clarity.
Co-authored-by: Benjie <benjie@jemjie.com>
Co-authored-by: Benjie <benjie@jemjie.com>
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.
This is the longest version of #2031, opened separately because requires more discussion/consensus.