forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add READMEs for API content directories (github#1895)
Co-authored-by: Rachael Sewell <[email protected]>
- Loading branch information
1 parent
c40ac98
commit 1588f50
Showing
3 changed files
with
22 additions
and
0 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# GraphQL | ||
|
||
The `/content/graphql` directory is where the GitHub GraphQL API docs live! | ||
|
||
* The `/content/graphql/guides` and `/content/graphql/overview` directories contain articles that are human-editable. | ||
* The `/content/graphql/reference` directory contains an article for each GraphQL data type used in the GitHub GraphQL API. Most of the content in this directory is rendered using `include` tags. | ||
|
||
The content rendered by `include` tags is sourced from the `/lib/graphql/static` directory, which is automatically generated from the API source code internally in GitHub, and should not be edited by a human. For more information, see the [`/lib/graphql/README.md`](/lib/graphql/README.md). | ||
|
||
**As a result, we cannot accept contributions to GraphQL API reference content in this repository.** |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# REST | ||
|
||
The `/content/rest` directory is where the GitHub REST API docs live! | ||
|
||
* The `/content/rest/guides` and `/content/rest/overview` directories contain regular articles. These are human-editable. | ||
* The `/content/rest/reference` directory contains an article for each group of endpoints in the GitHub REST API. Most of the content in this directory is rendered using `include` tags. | ||
|
||
The content rendered by `include` tags is sourced from the `/lib/rest/static` directory, which is automatically generated from the API source code internally in GitHub, and should not be edited by a human. For more information, see the [`/lib/rest/README.md`](/lib/rest/README.md). | ||
|
||
**As a result, we cannot accept contributions to REST API reference content in this repository.** |