diff --git a/README.md b/README.md index fbbaf2e15695..4a6554fc90b6 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,111 @@ # GitHub Docs -This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). - -GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. - -Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. - -## Contributing - -See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. - -We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. - -On the GitHub Docs site, you can click the make a contribution button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes. - - - -For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. - -If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. - -### Join us in discussions - -We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). - -### And that's it! - -If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). - -That's how you can easily become a member of the GitHub Documentation community. :sparkles: - -## READMEs - -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) -- [data/variables/README.md](data/variables/README.md) -- [components/README.md](components/README.md) -- [lib/liquid-tags/README.md](lib/liquid-tags/README.md) -- [middleware/README.md](middleware/README.md) -- [script/README.md](script/README.md) -- [stylesheets/README.md](stylesheets/README.md) -- [tests/README.md](tests/README.md) - -## License - -The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). - -All other code in this repository is licensed under the [MIT license](LICENSE-CODE). - -When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). - -## Thanks :purple_heart: - -Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! + + This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). + + This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. + GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. + + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. ## Contributing + + + ## Contributing See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. + + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. + + + We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. ## Contributing This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. + + + On the GitHub Docs site, you can click the make a contribution button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes. + + See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. + + + GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes. + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. + + + If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. + + On the GitHub Docs site, you can click the make a contribution button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes. Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + ### Join us in discussions + + + We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). + + + ### And that's it! ## Contributing For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. + + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. + If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). + + + That's how you can easily become a member of the GitHub Documentation community. :sparkles: If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. + + + ## READMEs + + ### Join us in discussions + 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: + + We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. ### Join us in discussions + - [content/README.md](content/README.md) We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). + - [content/graphql/README.md](content/graphql/README.md) + - [content/rest/README.md](content/rest/README.md) ### And that's it! + - [contributing/README.md](contributing/README.md) ### And that's it! If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). + - [data/README.md](data/README.md) + - [data/reusables/README.md](data/reusables/README.md) That's how you can easily become a member of the GitHub Documentation community. :sparkles: + - [data/variables/README.md](data/variables/README.md) If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). ## READMEs + - [components/README.md](components/README.md) + - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) + - [middleware/README.md](middleware/README.md) That's how you can easily become a member of the GitHub Documentation community. :sparkles: + - [script/README.md](script/README.md) + - [stylesheets/README.md](stylesheets/README.md) On the GitHub Docs site, you can click the make a contribution button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes. 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: + - [tests/README.md](tests/README.md) ## READMEs + + + ## License + + 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) + The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). + + - [content/graphql/README.md](content/graphql/README.md) + All other code in this repository is licensed under the [MIT license](LICENSE-CODE). - [content/README.md](content/README.md) - [content/rest/README.md](content/rest/README.md) + + - [content/graphql/README.md](content/graphql/README.md) - [contributing/README.md](contributing/README.md) + When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). - [content/rest/README.md](content/rest/README.md) - [data/README.md](data/README.md) + + - [contributing/README.md](contributing/README.md) - [data/reusables/README.md](data/reusables/README.md) + ## Thanks :purple_heart: - [data/README.md](data/README.md) - [data/variables/README.md](data/variables/README.md) + + - [data/reusables/README.md](data/reusables/README.md) - [includes/liquid-tags/README.md](includes/liquid-tags/README.md) + Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! - [data/variables/README.md](data/variables/README.md) - [includes/README.md](includes/README.md) + - [components/README.md](components/README.md) - [components/README.md](components/README.md) + - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) + - [middleware/README.md](middleware/README.md) - [middleware/README.md](middleware/README.md) + - [script/README.md](script/README.md) - [script/README.md](script/README.md) + - [stylesheets/README.md](stylesheets/README.md) - [stylesheets/README.md](stylesheets/README.md) + - [tests/README.md](tests/README.md) - [tests/README.md](tests/README.md) + + ## License + ## License The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). + + + The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). + + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. All other code in this repository is licensed under the [MIT license](LICENSE-CODE). + All other code in this repository is licensed under the [MIT license](LICENSE-CODE). + + + When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). + + + ## Thanks :purple_heart: + + ### Join us in discussions ## Thanks :purple_heart: + Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! + + We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: !