GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • GitHub Docs
  • Contribute to GitHub Docs
  • Best practices for GitHub Docs
  • Documentation philosophy
  • Documentation fundamentals
  • Content design principles
  • Write content to be translated
  • Make content findable
  • Versioning documentation
  • Markdown and Liquid
  • YAML frontmatter
  • Create reusable content
  • Create screenshots
  • Create diagrams

This view

  • Original page
  • New address

GeezerVison is showing docs.github.com — Contributing to GitHub Docs documentation - GitHub Docs

Contributing to GitHub Docs documentation

Learn about how the GitHub Docs team creates documentation and how you can contribute.

OverviewQuickstart

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
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.