docs: add linting and code snippet validation #1983
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
|
@sarahxsanders is attempting to deploy a commit to the The GraphQL Foundation Team on Vercel. A member of the Team first needs to authorize it. |
saihaj
reviewed
Apr 7, 2025
saihaj
reviewed
Apr 7, 2025
saihaj
approved these changes
Apr 8, 2025
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
benjie
requested changes
Apr 10, 2025
There was a problem hiding this comment.
This is awesome! I'm going to integrate some of the improvements here into my own software! 😁
I've left some small suggested tweaks below, but only 2 are potential blockers: the concern about adding a new page and linking to it from existing pages, and the one where operation is changed to mutation
|
@benjie added a commit to build locally for link checking |
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.
Description
This PR introduces linting and code snippet validation for GraphQL snippets. JS snippets are commented out on this PR, because I will modernize the JS code snippets first.
Changes
validate-snippets.jsscript that extracts code snippets from MDX files and validates them against parsers. Note, I temporarily commented out JS validation logic until those code snippets are modernized to meet the latest standards.<!-- snippet-ignore -->for GQL snippets causing errorsComments
Review