Add READMEs for API content directories #1895
Merged
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
rachmari
approved these changes
Dec 8, 2020
There was a problem hiding this comment.
@lucascosti the README pages are ignored, so adding these shouldn't affect the docs site. I added a few suggestions, but no blockers. 🚢
Co-authored-by: Rachael Sewell <rachmari@github.com>
|
Thanks for confirming, @rachmari! ❤️ This should be ready to merge |
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. |
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.
Closes: #1094
Why:
It's not clear to contributors that the reference content for the REST and GraphQL APIs are generated from the API source internally within GitHub, and as a result we can't accept contributions for them in this repository.
What's being changed:
Added READMEs to both the REST and GraphQL content directories to explain their structure and that the reference content is generated using
includes.Previews:
restdirectory READMEgraphqldirectory READMECheck off the following: