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
- translations guide for writers - 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
- troubleshooting - some help for troubleshooting failed and stalled status checks
You can also read the READMEs in the src/ directory to learn more about the features of the docs site.