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
in the top right corner to quickly jump between sections.
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
✅ 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 →
📝 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.
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.
- 📚 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
If you're having issues with your GitHub account or docs access, please reach out to GitHub Support.
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. ✨