2020-09-27 15:10:11 +03:00
## GitHub Docs <!-- omit in toc -->
2013-01-08 15:55:39 +04:00
2020-10-08 16:30:00 +03:00
This repository contains the documentation website code and Markdown source files for [docs.github.com ](https://docs.github.com ).
2020-09-27 15:10:11 +03:00
2020-10-06 00:44:29 +03:00
GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.
2020-09-27 15:10:11 +03:00
2021-08-27 19:58:57 +03:00
## Table of contents
2020-09-27 15:10:11 +03:00
2021-08-27 19:58:57 +03:00
Use the table of contents icon < img src = "./assets/images/table-of-contents.png" width = "25" height = "25" / > on the top left corner of the this document to get to a specific section of this guide quickly.
2020-09-27 15:10:11 +03:00
## Contributing
2021-08-27 19:58:57 +03:00
See our [CONTRIBUTING.md ](CONTRIBUTING.md ) for detailed instructions of how to get started with our project.
<!-- info about codetour/codespaces (https://github.com/github/docs - team/issues/800) -->
2020-09-27 15:10:11 +03:00
2021-08-27 19:58:57 +03:00
We accept different [types of contributions ](CONTRIBUTING.md/#types-of-contributions-memo ), including some that don't require you to write a single line of code.
2020-10-06 02:21:26 +03:00
2021-09-03 15:43:33 +03:00
On the GitHub Docs site, you can click **make a contribution** to open a PR for quick fixes like typos, updates, or link fixes.
2020-10-06 02:21:26 +03:00
2020-10-06 03:07:52 +03:00
< img src = "./assets/images/contribution_cta.png" width = "400" >
2020-10-06 01:31:14 +03:00
2021-09-03 15:45:13 +03:00
For more complex contribution, you can **open an issue** using an [issue template ](https://github.com/github/docs/issues/new/choose ) to describe the changes you'd like to see.
2020-09-27 15:10:11 +03:00
2021-08-27 19:58:57 +03:00
**Solve an issue** by first scanning through our [existing issues ](https://github.com/github/docs/issues ). When ready, check out [Getting Started with Contributing ](/CONTRIBUTING.md ) for detailed instructions.
2020-10-08 01:00:46 +03:00
2021-08-27 19:58:57 +03:00
### Join us in discussions
2020-10-06 01:31:14 +03:00
2020-10-06 00:44:29 +03:00
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 [discussions ](https://github.com/github/docs/discussions ).
2020-09-27 15:10:11 +03:00
2021-08-27 19:58:57 +03:00
### And that's it!
2020-11-19 17:04:18 +03:00
2021-08-27 19:58:57 +03:00
If you're having trouble with your GitHub account, contact [Support ](https://support.github.com/contact ).
2020-10-06 01:31:14 +03:00
2021-08-27 19:58:57 +03:00
That's how you can easily become a member of the GitHub Documentation community. :sparkles:
2020-10-06 00:44:29 +03:00
2021-08-27 20:27:16 +03:00
If you want to know more, or you're making a more complex contribution, check out [CONTRIBUTING.md ](/CONTRIBUTING.md ).
2020-09-27 15:10:11 +03:00
## 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 )
2020-12-10 06:31:10 +03:00
- [content/graphql/README.md ](content/graphql/README.md )
- [content/rest/README.md ](content/rest/README.md )
2020-10-01 21:27:27 +03:00
- [contributing/README.md ](contributing/README.md )
2020-09-27 15:10:11 +03:00
- [data/README.md ](data/README.md )
- [data/reusables/README.md ](data/reusables/README.md )
- [data/variables/README.md ](data/variables/README.md )
- [includes/liquid-tags/README.md ](includes/liquid-tags/README.md )
- [includes/README.md ](includes/README.md )
2021-07-27 19:07:18 +03:00
- [components/README.md ](components/README.md )
2020-09-27 15:10:11 +03:00
- [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
2020-10-08 01:11:49 +03:00
The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license ](LICENSE ).
2020-09-27 15:10:11 +03:00
2020-10-08 01:11:49 +03:00
All other code in this repository is licensed under a [MIT license ](LICENSE-CODE ).
2020-09-27 15:10:11 +03:00
When using the GitHub logos, be sure to follow the [GitHub logo guidelines ](https://github.com/logos ).
2021-08-27 19:58:57 +03:00
## Thanks :purple_heart:
Thanks for all your contributions and efforts towards the GitHub documentation. We thank you being part of our enormous community!!
