diff --git a/README.md b/README.md index 01eee7da20ce..4ea2e2669066 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,86 @@ -# GitHub Docs -[![Build GitHub Docs On Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/?repo=github) +# πŸ“˜ GitHub Docs +[![Open in Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/?repo=github) -This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). +Welcome to the **GitHub Docs** repository! +This repo contains all the documentation site code and Markdown source 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. +> πŸ› οΈ The GitHub Docs team maintains pre-production content in a private repo that syncs regularly with this one. -Use the table of contents icon Table of contents icon on the top right corner of this document to navigate to a specific section quickly. +Use the πŸ“‘ table of contents icon +Table of contents icon +in the top right corner to quickly jump between sections. -## Contributing +--- -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). +## 🌟 Why Contribute? -### Ways to contribute +We believe **great documentation builds better developers**. +Whether you're fixing a typo, enhancing technical accuracy, or suggesting new content β€” **your contributions matter**. -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. +πŸ‘‰ Start here: [How to Contribute](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs) -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). +--- -Contribution call-to-action +## ✨ Ways to Contribute -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. +βœ… **Quick Edits**: +Click the **"Make a contribution"** button at the bottom of any docs page to edit directly (great for fixing typos, broken links, etc.). -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. +πŸ§ͺ **Advanced Contributions**: +Set up the project locally or spin up a Codespace to suggest bigger changes. +[Guide β†’](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs) -### And that's it! +

+ Contribution Call-to-Action +

-If you're having trouble with your GitHub account, contact [Support](https://support.github.com). +πŸ“ **Feature or Doc Request?** +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. -That's how you can easily become a member of the GitHub Docs community. :sparkles: +πŸ” **Want to help, but not sure where to start?** +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. -## 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: +## 🧩 Project Structure -- [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) -- [src/README.md](src/README.md) +This repo includes several subdirectories, each with their own purpose: -## License +| Path | Description | +|------------------------------|----------------------------------------| +| `content/` | Core Markdown documentation | +| `content/graphql/` | GraphQL API docs | +| `content/rest/` | REST API docs | +| `contributing/` | Contribution guides | +| `data/` | YAML-driven data & content blocks | +| `data/reusables/` | Reusable markdown snippets | +| `data/variables/` | Site-wide variables | +| `src/` | Website source code | -The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). +Explore individual READMEs for more details. -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). +## πŸ“œ License -## Thanks :purple_heart: +- πŸ“š Documentation (`assets`, `content`, `data`) is licensed under [**CC-BY 4.0**](LICENSE) +- πŸ’» Code (everything else) is licensed under the [**MIT License**](LICENSE-CODE) -Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! +πŸ”— If using GitHub’s logo or branding, be sure to follow our [Logo Guidelines](https://github.com/logos) + +--- + +## πŸ’¬ Need Help? + +If you're having issues with your GitHub account or docs access, please reach out to [GitHub Support](https://support.github.com). + +--- + +## πŸ’– Thank You! + +We appreciate every contribution β€” big or small. +Thank you for helping make the GitHub Docs better for developers everywhere. πŸš€ + +

+ ✨ Let’s build better docs, together. ✨ +