Contributing to GitHub Docs documentation
Learn about how the GitHub Docs team creates documentation and how you can contribute.
Start here
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.
About the content model
The content model describes the structure and types of content that we publish.
About contributing to GitHub Docs
You can contribute to GitHub Docs content in several ways.
Writing for GitHub Docs
- Best practices for GitHub Docs
- About GitHub's documentation philosophy
- About GitHub's documentation fundamentals
- Content design principles
- Writing content to be translated
- Making content findable in search
- Versioning documentation
- Using Markdown and Liquid in GitHub Docs
- Using YAML frontmatter
- Using videos in GitHub Docs
- Creating reusable content
- Creating screenshots
- Creating diagrams for GitHub Docs
- Creating tool switchers in articles
- Configuring redirects
- Changing an article's title
- Annotating code examples
- Templates