GitHub

How GitHub uses GitHub to document GitHub

Jan 7, 2015Garen Torikian
How GitHub uses GitHub to document GitHub
SummaryAI, from the source post

This post details the migration of the GitHub Help site from a custom-built Rails application to a static Jekyll site hosted on GitHub Pages. Key technical aspects include: replacing a Rails app with Jekyll for serving documentation, using Jekyll's Collections and data files for content references (conrefs), implementing versioned documentation using Liquid tags and audience flags in `_config.yml`, switching from Elasticsearch to lunr-js for client-side search, and leveraging `html-proofer` and Capybara for testing. The migration aimed to improve performance, reduce operational overhead, and simplify the documentation workflow.

More from the High Availability Search Architecture for GitHub Enterprise Server trail