docs
The open-source repo for docs.github.com
Explore the github/docs data directory structure and learn how YAML variables, UI strings, and feature flags are managed. Understand content loading with automatic English fallback.
Managing Reusables and Includes in GitHub Docs: Content Architecture PatternsDiscover content architecture patterns for managing reusables and includes in GitHub Docs. Learn how GitHub Docs uses Liquid and TypeScript for efficient Markdown fragment management.
How GraphQL API Documentation Synchronization Works in GitHub DocsLearn how GitHub Docs synchronizes GraphQL API documentation by auto-generating reference pages from JSON schema during the Nextjs build process using PageTransformers.
OpenTelemetry Instrumentation in GitHub Docs: Distributed Tracing for the Copilot SDKDiscover how github/docs uses OpenTelemetry instrumentation for distributed tracing with the Copilot SDK. Learn about span export, OTLP HTTP, and W3C Trace-Context propagation.
How the GitHub Docs Content Linter Validates Documentation QualityDiscover how the GitHub Docs content linter validates documentation quality through a seven-stage pipeline using markdownlint, custom rules, and auto-fixing.
How the github/docs Link Validation System Detects Broken LinksDiscover how the github/docs link validation system finds broken links. Learn about its internal and external checkers, parsing, rendering, and validation processes.
How REST API Reference Docs Are Auto-Generated and Synced in GitHub DocsDiscover how GitHub Docs auto-generates REST API reference documentation from OpenAPI specs. Learn about the three-stage pipeline and continuous syncing via GitHub Actions workflows.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" 
Maintain an open-source project? Get it listed too →