Engaging Readers through Interactive Documentation

Developer-facing products typically include code examples in their documentation. Most of these code examples are static and require a reader to set up an environment before exploring them.

A better alternative is to make the examples interactive, allowing readers to try it out right in the browser. Building such interactivity is hard, but it can be made easier with Codapi.

Codapi is an open-source platform that helps you build and embed interactive code snippets in your browser.

In this talk, Navendu walks through how he uses Codapi to build interactive documentation and how others can do it too to create interactive documentation, blog posts, and playgrounds and easily engage their readers.