Take aways from the Github docs site revamp

Github launched a revamp of their documentation site on July 2nd, 2020, and their launch blog post had lots of useful points.

  1. Versioning documentation is hard. It is well worth thinking about the the url structures ahead of time.
  2. Unlike GraphDoc, the GraphQL Docs tool they used allows linking to specific operations.

Leave a Reply