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
Add a style guide to the specification #1003
Conversation
✅ Deploy Preview for graphql-spec-draft ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One nit but the actual changes look good.
I looked into using vale.sh but that looks like it's going to be a fair amount of setup (not least because it's a native binary, so getting it running everywhere is a bit more complex than an |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Two TSC approvals, editorial only, based on last night's discussion I'm going to go ahead and merge it 👍 |
@rivantsov pointed out in #981 that there is inconsistent capitalization in the spec.
I've done some research and have concluded that our style seems to most-closely match the AP style guide, so I have worked my way through every heading in the document and applied this style to them. I've also outlined the very basics of this in a style guide document.
You can see some of my analysis in this comment:
#981 (comment)
After that I expanded to looking at all headings in the document. I include below the before/after for the document headings, sorted alphabetically, using
grep -hEr '(^#|^\*\*.*\*\*$)' . | sort -u
before
after
Closes #981