Skip to content

Latest commit

 

History

History

contributing

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
images
images
 
 
README.md
README.md
 
 
code-annotations.md
code-annotations.md
 
 
codespace.md
codespace.md
 
 
content-markup-reference.md
content-markup-reference.md
 
 
content-model.md
content-model.md
 
 
content-style-guide.md
content-style-guide.md
 
 
content-templates.md
content-templates.md
 
 
debugging-the-docs-application.md
debugging-the-docs-application.md
 
 
deployments.md
deployments.md
 
 
development.md
development.md
 
 
how-to-use-labels.md
how-to-use-labels.md
 
 
images-and-versioning.md
images-and-versioning.md
 
 
liquid-helpers.md
liquid-helpers.md
 
 
node-versions.md
node-versions.md
 
 
redirects.md
redirects.md
 
 
self-review.md
self-review.md
 
 
tool-switcher.md
tool-switcher.md
 
 
translations-for-translators.md
translations-for-translators.md
 
 
translations-for-writers.md
translations-for-writers.md
 
 
troubleshooting.md
troubleshooting.md
 
 
types-of-contributions.md
types-of-contributions.md
 
 
videos-in-docs.md
videos-in-docs.md
 
 
videos.md
videos.md
 
 

README.md

Contributing to github/docs

Check out our contributing guide to see all the ways you can participate in the GitHub docs community 💖

Visit "Contributing to GitHub Docs documentation" for additional information about how to write and collaborate the GitHub Docs way.

Here, you'll find additional information that might be helpful as you work on a pull request in this repo.

  • development - steps for getting this app running on your local machine
  • deployments - how our staging and production environments work
  • liquid helpers - using liquid helpers for versioning in our docs
  • translations guide for writers - making sure your content is ready to be translated
  • node versions - our site runs on Node.js
  • troubleshooting - some help for troubleshooting failed and stalled status checks
  • Reusables - We create reusables and call them from articles to help us keep content that is used in multiple places up to date.
  • Variables - We use variables the same way we use reusables. Variables are for short strings of reusable text.
  • Tests - We use tests to ensure content will render correctly on the site. Tests run automatically in your PR, and sometimes it's also helpful to run them locally.

You can also read the READMEs in the src/ directory to learn more about the features of the docs site.