CloudFlare's JSON-powered Documentation Generator

Vojtech Miksu shares insights into Cloudflare's RESTful API documentation process and introduces a set of tools used for generating the same. The company uses JSON Hyper-Schema to describe their API, which is then used to generate HTML documentation. They have an open source library called JSON Schema Docs Generator (JSDC) that generates complete HTML documentation from JSON Schema files and Handlebars.js templates. However, they found it hard to use for other teams due to its complicated configuration and slow performance. To address these issues, they created a toolchain based on JSDC and modern JavaScript libraries. They also introduced doca, a command-line tool that scaffolds the whole application for users. The tools are designed to be modular and extensible while still providing ready-to-go output with just a few commands.