docs/contributing
Sarah Edwards dac4144086
PAT v2 beta (#31013)
Co-authored-by: Hirsch Singhal <1666363+hpsin@users.noreply.github.com>
Co-authored-by: Jovel Crisostomo <jovel@github.com>
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
Co-authored-by: Vanessa <vgrl@github.com>
2022-10-18 15:11:04 +00:00
..
github-partners
images
README.md
codespace.md
content-markup-reference.md Update content-markup-reference.md (#31677) 2022-10-14 11:42:36 +00:00
content-model.md Add content model for the tool switcher (#31393) 2022-10-10 20:37:06 +00:00
content-style-guide.md Add instructions for linking to specific tools (#31654) 2022-10-12 21:10:15 +00:00
content-templates.md PAT v2 beta (#31013) 2022-10-18 15:11:04 +00:00
debugging-the-docs-application.md move debugging docs to new file and clarify 2022-07-14 11:51:00 -04:00
deployments.md Add link to merge queue doc (#30983) 2022-09-21 07:02:43 -07:00
development.md re-read content on every request (#30646) 2022-09-13 13:06:33 +00:00
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 document all the things 2022-07-22 11:20:30 -04:00
search.md add note about skipping index check to search docs 2022-04-12 11:20:13 -04:00
self-review.md
tool-switcher.md Add instructions for linking to specific tools (#31654) 2022-10-12 21:10:15 +00:00
troubleshooting.md Remove dotcom-only class (#28525) 2022-06-28 07:18:59 +00:00
types-of-contributions.md Update types-of-contributions.md 2022-09-13 17:08:55 -05:00
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