Skip to content

Commit 1588f50

Browse files
lucascostirachmari
andauthored
Add READMEs for API content directories (github#1895)
Co-authored-by: Rachael Sewell <[email protected]>
1 parent c40ac98 commit 1588f50

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ There are a few more things to know when you're getting started with this repo:
5050
In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail:
5151

5252
- [content/README.md](content/README.md)
53+
- [content/graphql/README.md](content/graphql/README.md)
54+
- [content/rest/README.md](content/rest/README.md)
5355
- [contributing/README.md](contributing/README.md)
5456
- [data/README.md](data/README.md)
5557
- [data/reusables/README.md](data/reusables/README.md)

content/graphql/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# GraphQL
2+
3+
The `/content/graphql` directory is where the GitHub GraphQL API docs live!
4+
5+
* The `/content/graphql/guides` and `/content/graphql/overview` directories contain articles that are human-editable.
6+
* 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.
7+
8+
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).
9+
10+
**As a result, we cannot accept contributions to GraphQL API reference content in this repository.**

content/rest/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# REST
2+
3+
The `/content/rest` directory is where the GitHub REST API docs live!
4+
5+
* The `/content/rest/guides` and `/content/rest/overview` directories contain regular articles. These are human-editable.
6+
* 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.
7+
8+
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).
9+
10+
**As a result, we cannot accept contributions to REST API reference content in this repository.**

0 commit comments

Comments
 (0)