Skip to content

Commit

Permalink
Add READMEs for API content directories (github#1895)
Browse files Browse the repository at this point in the history
Co-authored-by: Rachael Sewell <[email protected]>
  • Loading branch information
lucascosti and rachmari authored Dec 10, 2020
1 parent c40ac98 commit 1588f50
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ There are a few more things to know when you're getting started with this repo:
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:

- [content/README.md](content/README.md)
- [content/graphql/README.md](content/graphql/README.md)
- [content/rest/README.md](content/rest/README.md)
- [contributing/README.md](contributing/README.md)
- [data/README.md](data/README.md)
- [data/reusables/README.md](data/reusables/README.md)
Expand Down
10 changes: 10 additions & 0 deletions content/graphql/README.md
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.**
10 changes: 10 additions & 0 deletions content/rest/README.md
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.**

0 comments on commit 1588f50

Please sign in to comment.