Contributing to GitHub Docs documentation
Learn about how the GitHub Docs team creates documentation and how you can contribute.
Recommended
About contributing to GitHub Docs
You can contribute to GitHub Docs content in several ways.
Best practices for GitHub Docs
Follow these best practices to create documentation that's user-friendly and easy to understand.
Style guide
Follow this guide to make sure GitHub's documentation stays consistent and follows clear patterns that our readers can understand.
Articles
Follow the style guide and content model
About combining multiple content types
You can combine multiple content types in a single article to help people complete complex tasks.
Get set up to contribute
About contributing to GitHub Docs
You can contribute to GitHub Docs content in several ways.
Understand the GitHub approach to docs
About GitHub's documentation fundamentals
All content published on GitHub Docs must meet these fundamental requirements.
Understand the GitHub approach to docs
About GitHub's documentation philosophy
Our documentation philosophy guides what content we create and how we create it.
Follow the style guide and content model
About the content model
The content model describes the structure and types of content that we publish.
Write and format content
Annotating code examples
You can annotate longer code examples to explain how they work and how people can customize them for other uses.
Understand the GitHub approach to docs
Best practices for GitHub Docs
Follow these best practices to create documentation that's user-friendly and easy to understand.
Write and format content
Changing an article's title
When it's necessary to change the title of an article, the name may need to be updated in several places.
Follow the style guide and content model
Concepts content type
People most often use conceptual content when they are learning about something new to them.
Showing 1-9 of 37