DEV Community

loading...
GitHub

GitHub Docs is Open Source

mishmanners profile image Michelle Mannering ・2 min read

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 logo github / docs

The open-source repo for docs.github.com

GitHub Docs

This repository contains the documentation website code and Markdown source files for docs.github.com.

GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.

In this article:

Contributing

Start contributing right now:

We accept a lot of different contributions, including some that don't require you to write a single line of code.

Click make a contribution from docs

As you're using the GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on make a contribution to navigate directly to that article in the codebase, so that you can begin making your contribution.

Open an issue

If you've found a problem, you can open an issue using a template.

Solve an issue

If you have a solution to one of the open issues, you will need…

Discussion

pic
Editor guide