|
1 | | -# GitHub Docs <!-- omit in toc --> |
2 | | -[](https://github.com/codespaces/new/?repo=github) |
| 1 | +# 📘 GitHub Docs <!-- omit in toc --> |
| 2 | +[](https://github.com/codespaces/new/?repo=github) |
3 | 3 |
|
4 | | -This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). |
| 4 | +Welcome to the **GitHub Docs** repository! |
| 5 | +This repo contains all the documentation site code and Markdown source for [**docs.github.com**](https://docs.github.com). |
5 | 6 |
|
6 | | -GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. |
| 7 | +> 🛠️ The GitHub Docs team maintains pre-production content in a private repo that syncs regularly with this one. |
7 | 8 |
|
8 | | -Use the table of contents icon <img alt="Table of contents icon" src="./contributing/images/table-of-contents.png" width="25" height="25" /> on the top right corner of this document to navigate to a specific section quickly. |
| 9 | +Use the 📑 table of contents icon |
| 10 | +<img alt="Table of contents icon" src="./contributing/images/table-of-contents.png" width="25" height="25" /> |
| 11 | +in the top right corner to quickly jump between sections. |
9 | 12 |
|
10 | | -## Contributing |
| 13 | +--- |
11 | 14 |
|
12 | | -We accept different types of contributions, including some that don't require you to write a single line of code. For detailed instructions on how to get started with our project, see [About contributing to GitHub Docs](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs). |
| 15 | +## 🌟 Why Contribute? |
13 | 16 |
|
14 | | -### Ways to contribute |
| 17 | +We believe **great documentation builds better developers**. |
| 18 | +Whether you're fixing a typo, enhancing technical accuracy, or suggesting new content — **your contributions matter**. |
15 | 19 |
|
16 | | -On the GitHub Docs site, you can contribute by clicking 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. |
| 20 | +👉 Start here: [How to Contribute](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs) |
17 | 21 |
|
18 | | -You can also contribute by creating a local environment or opening a Codespace. For more information, see [Setting up your environment to work on GitHub Docs](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs). |
| 22 | +--- |
19 | 23 |
|
20 | | -<img alt="Contribution call-to-action" src="./contributing/images/contribution_cta.png" width="400"> |
| 24 | +## ✨ Ways to Contribute |
21 | 25 |
|
22 | | -For more complex contributions, please [open an issue in the docs-content repo](https://github.com/github/docs-content/issues/new/choose) describing the changes you'd like to see. |
| 26 | +✅ **Quick Edits**: |
| 27 | +Click the **"Make a contribution"** button at the bottom of any docs page to edit directly (great for fixing typos, broken links, etc.). |
23 | 28 |
|
24 | | -If you're looking for a way to contribute, you can scan through our [help wanted board](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) to find open issues already approved for work. |
| 29 | +🧪 **Advanced Contributions**: |
| 30 | +Set up the project locally or spin up a Codespace to suggest bigger changes. |
| 31 | +[Guide →](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs) |
25 | 32 |
|
26 | | -### And that's it! |
| 33 | +<p align="center"> |
| 34 | + <img alt="Contribution Call-to-Action" src="./contributing/images/contribution_cta.png" width="400" /> |
| 35 | +</p> |
27 | 36 |
|
28 | | -If you're having trouble with your GitHub account, contact [Support](https://support.github.com). |
| 37 | +📝 **Feature or Doc Request?** |
| 38 | +Open an issue in the [**docs-content repo**](https://github.com/github/docs-content/issues/new/choose) and explain what you'd like to see. |
29 | 39 |
|
30 | | -That's how you can easily become a member of the GitHub Docs community. :sparkles: |
| 40 | +🔍 **Want to help, but not sure where to start?** |
| 41 | +Check out the [**Help Wanted** board](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) — all issues there are contributor-friendly. |
31 | 42 |
|
32 | | -## READMEs |
| 43 | +--- |
33 | 44 |
|
34 | | -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: |
| 45 | +## 🧩 Project Structure |
35 | 46 |
|
36 | | -- [content/README.md](content/README.md) |
37 | | -- [content/graphql/README.md](content/graphql/README.md) |
38 | | -- [content/rest/README.md](content/rest/README.md) |
39 | | -- [contributing/README.md](contributing/README.md) |
40 | | -- [data/README.md](data/README.md) |
41 | | -- [data/reusables/README.md](data/reusables/README.md) |
42 | | -- [data/variables/README.md](data/variables/README.md) |
43 | | -- [src/README.md](src/README.md) |
| 47 | +This repo includes several subdirectories, each with their own purpose: |
44 | 48 |
|
45 | | -## License |
| 49 | +| Path | Description | |
| 50 | +|------------------------------|----------------------------------------| |
| 51 | +| `content/` | Core Markdown documentation | |
| 52 | +| `content/graphql/` | GraphQL API docs | |
| 53 | +| `content/rest/` | REST API docs | |
| 54 | +| `contributing/` | Contribution guides | |
| 55 | +| `data/` | YAML-driven data & content blocks | |
| 56 | +| `data/reusables/` | Reusable markdown snippets | |
| 57 | +| `data/variables/` | Site-wide variables | |
| 58 | +| `src/` | Website source code | |
46 | 59 |
|
47 | | -The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). |
| 60 | +Explore individual READMEs for more details. |
48 | 61 |
|
49 | | -All other code in this repository is licensed under the [MIT license](LICENSE-CODE). |
| 62 | +--- |
50 | 63 |
|
51 | | -When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). |
| 64 | +## 📜 License |
52 | 65 |
|
53 | | -## Thanks :purple_heart: |
| 66 | +- 📚 Documentation (`assets`, `content`, `data`) is licensed under [**CC-BY 4.0**](LICENSE) |
| 67 | +- 💻 Code (everything else) is licensed under the [**MIT License**](LICENSE-CODE) |
54 | 68 |
|
55 | | -Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! |
| 69 | +🔗 If using GitHub’s logo or branding, be sure to follow our [Logo Guidelines](https://github.com/logos) |
| 70 | + |
| 71 | +--- |
| 72 | + |
| 73 | +## 💬 Need Help? |
| 74 | + |
| 75 | +If you're having issues with your GitHub account or docs access, please reach out to [GitHub Support](https://support.github.com). |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +## 💖 Thank You! |
| 80 | + |
| 81 | +We appreciate every contribution — big or small. |
| 82 | +Thank you for helping make the GitHub Docs better for developers everywhere. 🚀 |
| 83 | + |
| 84 | +<p align="center"> |
| 85 | + <strong>✨ Let’s build better docs, together. ✨</strong> |
| 86 | +</p> |
0 commit comments