docs
Othergithub/docs
Open-source repo for GitHub's documentation, allowing community contributions.
Overview
This repository hosts the source content for GitHub Docs, the documentation website for GitHub. It is open source, enabling both GitHub employees and external contributors to improve the documentation. The content includes guides, references, and tutorials for using GitHub products and features.
README Preview
# GitHub Docs \n\nWelcome to GitHub Docs! GitHub’s documentation is open source, meaning anyone from inside or outside the company can contribute. For full contributing guidelines, visit our [contributing guide](https://docs.github.com/en/contributing).\n\n\n## Quick links by contributor type\n\n* **Hubbers (GitHub employees):** See [CONTRIBUTING.md](https://github.com/github/docs-content/blob/main/CONTRIBUTING.md) in the `docs-content` repository for GitHub-specific processes.\n\n* **Open source contributors:** See [CONTRIBUTING.md](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) in the `docs` repository for a quick-start summary.\n\n## How we sync changes across Docs repositories\n\nThere are two GitHub Docs repositories: \n\n- **`github/docs`** (public): Open to external contributions\n\n- **`github/docs-internal`** (private): For GitHub employee contributions. \n\nThe two repositories sync frequently. Content changes in one are reflected in the other. Hubbers might prefer to post in `docs` when working with a customer, but `docs` has limitations on the types of contributions it accepts to safeguard the site and our workflows. Internal contributions should usually go to `docs-internal`.\n\n**Important:** The `docs` repository accepts contributions to content files (`.md` files in `/content` and select `/data` sections like reusables only). Infrastructure files, workflows, and site-building code are not open for external modification.\n\n## New to contributing\n\nHere are some resources to help you get started with open source contributions:\n\n* [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)\n* [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git)\n* [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)\n* [Collaborating with pull requests](https://docs.github.com/en/github
FAQ (2)
TroubleshootingWhy was my pull request fixing GitHub Docs translations closed?
GitHub Docs does not accept community changes to translated files (German, Japanese, etc.) because translations are managed through an internal, automated localization system. Direct edits to translated content will be closed. Instead, open an issue describing the translation problem—the docs team will flag it for their internal localization team. Contributions to the English source content are still accepted via normal PRs.
how_toHow do I configure GitHub Actions Runner Controller (ARC) to authenticate with a GitHub App on a personal account?
This is supported; the GitHub App does not need to be owned or installed by an organization. Create or open the app under your personal account at https://github.com/settings/apps/APP_SLUG, install it on your personal account, and copy the installation ID—the numeric ID shown on the installation settings page. Configure ARC using the same GitHub App settings as for an organization: github_app_id, github_app_installation_id, and github_app_private_key. For organization-owned apps, the corresponding settings URL is https://github.com/organizations/ORG/settings/apps/APP_SLUG; ARC itself handles both installation types the same way. The documentation limitation was corrected in PR #46167.