In this session, we speak to Open Documentation Academy contributor David Ekete, who successfully created a wonderful interactive command line for documentation. We discuss implementation details and also the potential pitfalls of adding interactive elements to your documentation.
The slides for David’s presentation are here.
Huge thank you to David Ekete for this presentation, and for his work on the Academy, and thanks to @dimple-kuriakose for all the support.
¬00:00 Intro
01:40 Presentation start
03:00 The process
03:10 Building the Design Requirements Document
04:00 Possible improvements
05:20 Building the interactive component
05:58 Add the component to Sphinx
07:40 Final results
08:10 Thanks
08:20 Questions
09:00 How was the logic codes?
11:30 Could this be used with Markdown?
12:00 What were the engineering contraints?
15:00 The most challenging aspect
18:00 Can we influence design?
22:00 Does this challenge the purity of technical documentation?
32:00 Should we have more issues like these in the Academy?