docs/contributing
Sarah Edwards 25de8aae83
note cases where em tag won't work (#30707)
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2022-09-16 18:12:47 +00:00
..
github-partners Migrate content model and templates to the public repo (#19141) 2021-05-04 22:29:46 +00:00
images Fix broken images (#24835) 2022-01-31 22:21:26 +00:00
README.md repo sync (#16442) 2022-03-22 11:47:40 -04:00
codespace.md repo sync (#16442) 2022-03-22 11:47:40 -04:00
content-markup-reference.md note cases where em tag won't work (#30707) 2022-09-16 18:12:47 +00:00
content-model.md Update learning lab links to skills (#28135) 2022-06-06 15:34:57 +00:00
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 Update learning lab links to skills (#28135) 2022-06-06 15:34:57 +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 Hello git history spelunker! 2020-09-27 14:10:11 +02:00
development.md re-read content on every request (#30646) 2022-09-13 13:06:33 +00:00
how-to-use-labels.md Update how-to-use-labels.md 2021-09-08 14:31:26 -05:00
images-and-versioning.md Github -> GitHub in our docs (fix spelling) (#26611) 2022-04-02 08:29:57 +00:00
liquid-helpers.md Update note about liquid conditionals for feature-based versioning 2022-08-11 12:42:50 +00:00
localization-checklist.md Update README.md (#24239) 2022-01-12 21:08:11 +00:00
node-versions.md typo: enviroment -> environment 2020-11-04 14:38:41 -05:00
permalinks.md remove no longer relevant info 2021-01-15 12:05:16 -05:00
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 self-review.md fix link to localization checklist 2021-09-23 16:05:08 -07: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 Update working-in-docs-repository.md 2021-09-21 12:59:45 -05:00

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