GitHub is giving you the power. At GitHub, we believe in the collective power of the community. The community has so much to offer and everyone is so knowledgeable. That's why, this October, we open sourced our GitHub Docs.
We wanted to give you the power to shape the documentation you know and love. We're encouraging you to engage, discuss, collaborate, and contribute to the docs that make your life easier.
Whether you're a first time contributor or a veteran to open source, the Docs team wants you. Contributions are welcome from everyone, no matter what background or skill level.
GitHub Docs are written in markdown which most people are familiar with. Even if you're not, markdown is relatively easy to learn and understand. The Docs website is written in JavaScript and Node. Since the two are separated - the website and the Docs - you don't need to be a JavaScript expert to contribute to GitHub Docs.
Contribute to GitHub Docs
There's lots of ways to get involved. If you have an idea, open a discussion. Start chatting with other people who have opened discussions too. If you'd like to update something, go for it! Open an issue to get started with your contributions. And if you want to work on a specific issue or feature request, open a pull request.
Plus there's lots of other ways to be involved too, and tonnes of plans for the future of GitHub Docs. Head over to the Docs website to check it out and enter to repo to get started today. We're looking forward to seeing lots of you engaging in GitHub Docs and we're excited to bring the power of GitHub Docs back to the community.
GitHub Docs
Welcome to GitHub Docs! GitHub’s documentation is open source, meaning anyone from inside or outside the company can contribute. For full contributing guidelines, visit our contributing guide
Quick links by contributor type
-
Hubbers (GitHub employees): See CONTRIBUTING.md in the
docs-contentrepository for GitHub-specific processes. -
Open source contributors: See CONTRIBUTING.md in the
docsrepository for a quick-start summary.
How we sync changes across Docs repositories
There are two GitHub Docs repositories:
-
github/docs(public): Open to external contributions -
github/docs-internal(private): For GitHub employee contributions.
The two repositories sync frequently. Content changes in one are reflected in the other. Hubbers might prefer to post in docs when working with a customer, but docs has limitations on the types of contributions it accepts to safeguard the site and our workflows. Internal contributions should usually go to docs-internal.
Important: The docs repository accepts contributions to content files (.md files in /content…
Top comments (0)