docs/contributing
Ethan Palm 7cd3fb4d5e
Update file and directory name guidance in style guide (#30424)
2022-08-31 20:03:51 +00:00
..
github-partners
images
README.md
codespace.md
content-markup-reference.md
content-model.md
content-style-guide.md Update file and directory name guidance in style guide (#30424) 2022-08-31 20:03:51 +00:00
content-templates.md
debugging-the-docs-application.md
deployments.md
development.md
how-to-use-labels.md
images-and-versioning.md
liquid-helpers.md Update note about liquid conditionals for feature-based versioning 2022-08-11 12:42:50 +00:00
localization-checklist.md
node-versions.md
permalinks.md
redirects.md
search.md
self-review.md
troubleshooting.md
types-of-contributions.md
working-in-docs-repository.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 💖

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
  • codespace - use GitHub Codespaces to work on documentation markdown files
  • content markup reference - how to use markup and features specific to the GitHub Docs site
  • content style guide - style guidance specific to GitHub Docs content and additional resources for writing clear, helpful content
  • content model - the content types that make up GitHub Docs and how to write them
  • content templates - handy templates to get you started with a new article
  • deployments - how our staging and production environments work
  • liquid helpers - using liquid helpers for versioning in our docs
  • localization checklist - making sure your content is ready to be translated
  • node versions - our site runs on Node.js
  • permalinks - permalinks for article versioning
  • redirects - configuring redirects in the site
  • search - our local site search functionality
  • troubleshooting - some help for troubleshooting failed and stalled status checks