Code the Docs: Interactive Document Environments
summary
Demonstrates putting runnable examples and written notes in one file so documentation and code are identical, using Jupyter / IPython notebooks for multi‑language analysis and an Swift Playgrounds authoring flow that supports pagination and time‑synced video. Shows a live regex golf example (editable regexes, surprising edge cases like only ten “losers” in one dataset), explains markdown formatting, hidden library code, and immediate visual feedback. Notes current limits: occasional crashes, limited language/framework support, and weak integration with traditional docs, but argues these environments can replace static books and tutorials.
AI-written summary · about
chapters (16)
- 0:00Intro
- 0:57Context
- 1:40Introduction
- 3:02Interactive Document Environments
- 5:12Interactive Document Environment Features
- 6:53IPython Notebooks
- 12:12Project Jupiter
- 14:47Project Oriole
- 19:50Playground
- 23:17strengths
- 24:27people love it
- 25:13weaknesses
- 27:01next steps
- 28:44how to do it
- 29:37OReilly
- 29:50Questions
related talks
28mCode the Docs: Interactive Document Environments
19mWhere Docs, Cloud-hosted Interactive Tutorials and CI Testing Intersect
20mPlaying with Interactive Documentation
34mReadme.md? We Can Do Better
49mUntitled13.ipynb
17mNotes on Notebooks: Is Jupyter the Bringer of Jollity?
46mDocumentation That Runs: Bridging Code, Prose, and Interactivity
01h 44mLeveling up your Jupyter notebook skills