Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
skedwards88 authored Jul 28, 2021
1 parent 61bd308 commit e204e44
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions content/rest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

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)
- [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 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)
- [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.

0 comments on commit e204e44

Please sign in to comment.