Skip to content

Latest commit

Β 

History

History
86 lines (56 loc) Β· 3.48 KB

File metadata and controls

86 lines (56 loc) Β· 3.48 KB

πŸ“˜ GitHub Docs

Open in Codespaces

Welcome to the GitHub Docs repository!
This repo contains all the documentation site code and Markdown source for docs.github.com.

πŸ› οΈ The GitHub Docs team maintains pre-production content in a private repo that syncs regularly with this one.

Use the πŸ“‘ table of contents icon
Table of contents icon
in the top right corner to quickly jump between sections.


🌟 Why Contribute?

We believe great documentation builds better developers.
Whether you're fixing a typo, enhancing technical accuracy, or suggesting new content β€” your contributions matter.

πŸ‘‰ Start here: How to Contribute


✨ Ways to Contribute

βœ… Quick Edits:
Click the "Make a contribution" button at the bottom of any docs page to edit directly (great for fixing typos, broken links, etc.).

πŸ§ͺ Advanced Contributions:
Set up the project locally or spin up a Codespace to suggest bigger changes.
Guide β†’

Contribution Call-to-Action

πŸ“ Feature or Doc Request?
Open an issue in the docs-content repo and explain what you'd like to see.

πŸ” Want to help, but not sure where to start?
Check out the Help Wanted board β€” all issues there are contributor-friendly.


🧩 Project Structure

This repo includes several subdirectories, each with their own purpose:

Path Description
content/ Core Markdown documentation
content/graphql/ GraphQL API docs
content/rest/ REST API docs
contributing/ Contribution guides
data/ YAML-driven data & content blocks
data/reusables/ Reusable markdown snippets
data/variables/ Site-wide variables
src/ Website source code

Explore individual READMEs for more details.


πŸ“œ License

  • πŸ“š Documentation (assets, content, data) is licensed under CC-BY 4.0
  • πŸ’» Code (everything else) is licensed under the MIT License

πŸ”— If using GitHub’s logo or branding, be sure to follow our Logo Guidelines


πŸ’¬ Need Help?

If you're having issues with your GitHub account or docs access, please reach out to GitHub Support.


πŸ’– Thank You!

We appreciate every contribution β€” big or small.
Thank you for helping make the GitHub Docs better for developers everywhere. πŸš€

✨ Let’s build better docs, together. ✨