What is this?
It is the open-source repository behind docs.github.com — GitHub's official documentation. Both the content and the site code live here, and anyone inside or outside GitHub can contribute.
It is the open-source repository behind docs.github.com — GitHub's official documentation. Both the content and the site code live here, and anyone inside or outside GitHub can contribute.Is this the live docs site, or the source behind it?Both halves live in one repo: the articles are Markdown files under /content (plus data such as reusables), rendered by a TypeScript Next.js app into docs.github.com.
Both halves live in one repo: the articles are Markdown files under /content (plus data such as reusables), rendered by a TypeScript Next.js app into docs.github.com.I spotted a typo in the docs — how do I get it fixed?The README points external contributors to CONTRIBUTING.md for a quick-start summary. A contribution is typically an edit to a Markdown file in /content or a select /data section, opened as a pull request.
The README points external contributors to CONTRIBUTING.md for a quick-start summary. A contribution is typically an edit to a Markdown file in /content or a select /data section, opened as a pull request.Do I need a specific Node version to work on it?Node.js ^24 or ^26, per the engines field in package.json. The repo also includes a Dockerfile if you would rather run it in a container, and the site builds with npm run build.
Node.js ^24 or ^26, per the engines field in package.json. The repo also includes a Dockerfile if you would rather run it in a container, and the site builds with npm run build.Can I change the site code too, or only the articles?Only content: external contributions are accepted for .md files in /content and select /data sections like reusables. Infrastructure files, workflows, and site-building code are not open for external modification.
Only content: external contributions are accepted for .md files in /content and select /data sections like reusables. Infrastructure files, workflows, and site-building code are not open for external modification.Is the documentation under the same license as the code?No — it is dual-licensed: Creative Commons Attribution 4.0 covers the documentation and content in the assets, content, and data folders, while the MIT License covers the code.
No — it is dual-licensed: Creative Commons Attribution 4.0 covers the documentation and content in the assets, content, and data folders, while the MIT License covers the code.What is the site built with?TypeScript on Next.js — the build script runs next build --webpack. Search is backed by Elasticsearch, and the app ships OpenTelemetry instrumentation for telemetry.
TypeScript on Next.js — the build script runs next build --webpack. Search is backed by Elasticsearch, and the app ships OpenTelemetry instrumentation for telemetry.If GitHub staff use a private repo, how do changes reach the public docs?github/docs is the public half and github/docs-internal is the private one for employees; the two sync frequently, so content changes in one are reflected in the other.
github/docs is the public half and github/docs-internal is the private one for employees; the two sync frequently, so content changes in one are reflected in the other.Can I republish GitHub's docs on my own site?The articles are under CC-BY-4.0, which allows reuse with attribution, and the code is MIT — so both are reusable if you follow those terms.
The articles are under CC-BY-4.0, which allows reuse with attribution, and the code is MIT — so both are reusable if you follow those terms.What are similar projects?docusaurus, docs, fumadocs, docz, emoji-cheat-sheet, PandaWiki, NotionNext, docsify
docusaurus, docs, fumadocs, docz, emoji-cheat-sheet, PandaWiki, NotionNext, docsifyWhich topics is it in?docs, opentelemetry, elasticsearch, search, github-actions, github, observability, nextjs, guide, documentation, developers, markdown
docs, opentelemetry, elasticsearch, search, github-actions, github, observability, nextjs, guide, documentation, developers, markdown