-
Notifications
You must be signed in to change notification settings - Fork 62.8k
Polished README for Better First Impressions #39262
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
NirajDN
wants to merge
5
commits into
github:main
Choose a base branch
from
NirajDN:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,86 @@ | ||
| # GitHub Docs <!-- omit in toc --> | ||
| [](https://github.com/codespaces/new/?repo=github) | ||
| # 📘 GitHub Docs <!-- omit in toc --> | ||
| [](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 <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. | ||
| Use the 📑 table of contents icon | ||
| <img alt="Table of contents icon" src="./contributing/images/table-of-contents.png" width="25" height="25" /> | ||
| 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). | ||
| --- | ||
|
|
||
| <img alt="Contribution call-to-action" src="./contributing/images/contribution_cta.png" width="400"> | ||
| ## ✨ 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! | ||
| <p align="center"> | ||
| <img alt="Contribution Call-to-Action" src="./contributing/images/contribution_cta.png" width="400" /> | ||
| </p> | ||
|
|
||
| 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. 🚀 | ||
|
|
||
| <p align="center"> | ||
| <strong>✨ Let’s build better docs, together. ✨</strong> | ||
| </p> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The bullet list has been converted to a table, but according to the content guidelines, bulleted points should be denoted using asterisks (*), not hyphens (-). While this is now a table, consider if the original bullet format with asterisks would be more appropriate for better consistency with the project's Markdown style guide.
Copilot uses AI. Check for mistakes.