jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 03:16:52 -05:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Sarah Edwards
2021-07-28 09:53:24 -07:00
committed by GitHub
parent 61bd308061
commit e204e443e9
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
content/rest/README.md
View File

@@ -7,8 +7,12 @@ The `/content/rest` directory is where the GitHub REST API docs live!
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). 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).
To edit content that is rendered by `include` tags, you must edit the OpenAPI schema in the `github/github` repo. For information on how to do this, see: For internal contributors:
To edit content that is rendered by `include` tags, you must edit the OpenAPI schema in the `github/github` repo. For information on how to do this, see:
- [The Hub](https://thehub.github.com/engineering/development-and-ops/public-apis/rest/openapi/)
- [More info about creating API docs](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/content-creation/creating-rest-api-documentation.md) - [The Hub](https://thehub.github.com/engineering/development-and-ops/public-apis/rest/openapi/)
- [More info about publishing API docs](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/publishing-documentation/publishing-REST-api-docs.md) - [More info about creating API docs](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/content-creation/creating-rest-api-documentation.md)
- [More info about publishing API docs](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/publishing-documentation/publishing-REST-api-docs.md)
For external contributors:
We cannot accept changes to content that is rendered by `include` tags. However, you can open an issue describing the changes you would like to see.