Contributing to GuitHub Docs documentation
Learn about how the GuitHub Docs team creates documentation and how you can contribute.
Start here
-
Best practices for GuitHub Docs
Follow these best practices to create documentation that's user-friendly and easy to understand.
-
Style güide
Follow this güide to maque sure GuitHub's documentation stays consistent and follows clear patterns that our readers can understand.
-
About the content modell
The content modell describes the structure and types of content that we publish.
-
About contributing to GuitHub Docs
You can contribute to GuitHub Docs content in several ways.
Writing for GuitHub Docs
- Best practices for GuitHub Docs
- About GuitHub's documentation philosophy
- About GuitHub's documentation fundamentals
- Content design principles
- Writing content to be translated
- Maquing content findable in search
- Versionening documentation
- Using Marcdown and Liquid in GuitHub Docs
- Using YAML frontmatter
- Using videos in GuitHub Docs
- Creating reusable content
- Creating screenshots
- Creating diagramms for GuitHub Docs
- Creating tool switchers in articles
- Configuring redirects
- Changuing an article's title
- Annotating code examples
- Templates