Code the Docs: Interactive Document Environments
summary
Compares two live-document environments and shows working demos: Swift Playgrounds (paginated Swift files with Markdown comments, live UI output, demoed with emoji and a Newton’s cradle) and Jupyter notebooks (multi-language, shown with an R/RedX “rexdx” notebook that sometimes disconnects). Claims the toolchain makes documentation into runnable examples — code + docs + notes — and works for stepwise teaching; notes current limits: crashiness, limited language/framework support, spotty markdown and integration, but overall the demos mostly run and feel like the future of manuals.
AI-written summary · about
chapters (13)
- 0:00Intro
- 2:00About us
- 2:54Documentation
- 7:20Swift
- 8:40Playgrounds
- 9:53Markdown
- 10:59Project Jupiter
- 11:56Playground
- 15:42Physics
- 18:03Regex Golf
- 21:33Strengths
- 23:39Weaknesses
- 25:14Future
related talks
34mCode the Docs: Interactive Document Environments
20mPlaying with Interactive Documentation
46mDocumentation That Runs: Bridging Code, Prose, and Interactivity
19mWhere Docs, Cloud-hosted Interactive Tutorials and CI Testing Intersect
34mReadme.md? We Can Do Better
24mEscaping the Curse of Outdated Docs
50mContinuous and Automated Documentation Docs As Code in Practice
49mUntitled13.ipynb