# GitHub Docs

## Docs

- [Content linter](https://mintlify.wiki/github/docs/content/content-linter.md): How to run the GitHub Docs content linter, what it checks, and how to fix or suppress lint errors.
- [Content model](https://mintlify.wiki/github/docs/content/content-model.md): How GitHub Docs is organized — content types, index pages, and the frontmatter that drives site navigation.
- [Filenames and directory structure](https://mintlify.wiki/github/docs/content/filenames-and-structure.md): How the /content directory maps to URLs, filename conventions, index pages, link formats, and how to add new articles correctly.
- [Frontmatter reference](https://mintlify.wiki/github/docs/content/frontmatter.md): Complete reference for every YAML frontmatter field recognized by the GitHub Docs site, with types, defaults, and examples.
- [Images and media](https://mintlify.wiki/github/docs/content/images-and-media.md): How to add, store, format, and version screenshots, diagrams, and videos in GitHub Docs.
- [Links and redirects](https://mintlify.wiki/github/docs/content/links-and-redirects.md): How to format internal and external links in GitHub Docs, and how to configure redirects when content moves.
- [Liquid helpers in GitHub Docs](https://mintlify.wiki/github/docs/content/liquid-helpers.md): Reference for all custom Liquid tags available in GitHub Docs content files, including data, versioning, octicons, tool switchers, and platform switchers.
- [Markdown and Liquid in GitHub Docs](https://mintlify.wiki/github/docs/content/markdown-and-liquid.md): An overview of GitHub Flavored Markdown, Liquid templating, frontmatter, links, images, and whitespace control used in GitHub Docs content files.
- [Reusables and variables](https://mintlify.wiki/github/docs/content/reusables-and-variables.md): How to use, create, and choose between reusable content blocks and short string variables in GitHub Docs.
- [Style guide](https://mintlify.wiki/github/docs/content/style-guide.md): Writing conventions for GitHub Docs—voice, tone, formatting, terminology, and article structure.
- [Versioning documentation](https://mintlify.wiki/github/docs/content/versioning.md): How GitHub Docs controls which content appears for each product version using frontmatter and Liquid conditionals.
- [Deployments](https://mintlify.wiki/github/docs/contributing/deployments.md): How GitHub Docs deployments work, including the merge queue, production rollout timing, staging environments, and branch cleanup.
- [Pull requests](https://mintlify.wiki/github/docs/contributing/pull-requests.md): How to fork the repository, make content changes, run the linter, and submit a pull request for review.
- [Translations](https://mintlify.wiki/github/docs/contributing/translations.md): How GitHub Docs handles translations, which languages are supported, and what external contributors can do.
- [Types of contributions](https://mintlify.wiki/github/docs/contributing/types-of-contributions.md): Learn what kinds of contributions are accepted in the github/docs repository and where to direct other types of feedback.
- [Debugging the application](https://mintlify.wiki/github/docs/development/debugging.md): Attach a debugger in VS Code, understand nodemon restarts, use fixture tests, and run the test suite.
- [Running the site locally](https://mintlify.wiki/github/docs/development/running-locally.md): Start the development server, configure languages, use the fixture server, and understand hot reload behavior.
- [Setting up your local environment](https://mintlify.wiki/github/docs/development/setup.md): Install Node.js, clone the repository, and prepare the GitHub Docs application to run on your machine.
- [Deployments](https://mintlify.wiki/github/docs/engineering/deployments.md): How changes to the docs codebase are deployed to staging and production.
- [GraphQL docs](https://mintlify.wiki/github/docs/engineering/graphql-docs.md): How GraphQL schema documentation is generated, validated, and rendered.
- [REST API docs](https://mintlify.wiki/github/docs/engineering/rest-api-docs.md): How REST API documentation is generated, synced, and maintained from the OpenAPI source.
- [REST documentation pipeline](https://mintlify.wiki/github/docs/engineering/rest-pipeline.md): How REST API reference documentation is auto-generated from OpenAPI, including the sync workflow, manual triggers, local development, and pipeline configuration.
- [Search](https://mintlify.wiki/github/docs/engineering/search.md): How docs.github.com search works, including the Elasticsearch backend, scraping and indexing pipeline, AI search autocomplete, and the search API endpoints.
- [Server overview](https://mintlify.wiki/github/docs/engineering/server-overview.md): Architecture of the docs.github.com Node.js application, including the Express and Next.js stack, subject folder pattern, and key src/ directories.
- [Testing](https://mintlify.wiki/github/docs/engineering/testing.md): How to run the test suite, what tests exist, and how to add new tests.
- [Troubleshooting](https://mintlify.wiki/github/docs/engineering/troubleshooting.md): Solutions to common issues contributors encounter when working on the GitHub Docs codebase.
- [Webhooks and GitHub Apps](https://mintlify.wiki/github/docs/engineering/webhooks-and-apps.md): How webhook and GitHub Apps documentation is generated from the OpenAPI and other automated pipelines.
- [Introduction](https://mintlify.wiki/github/docs/introduction.md): GitHub Docs is the open-source platform behind docs.github.com. Learn what it is, how the two repositories work together, and how you can contribute.
- [Quickstart](https://mintlify.wiki/github/docs/quickstart.md): Clone the github/docs repository, install dependencies, start the local dev server, make a content edit, and open a pull request — all in a few minutes.
- [Site architecture](https://mintlify.wiki/github/docs/site-architecture.md): A map of the github/docs repository — how content, data, and application source are organized, and how the Node.js/Express/Next.js server fits together.

## OpenAPI Specs

- [openapi](https://mintlify.wiki/github/docs/api-reference/openapi.json)