The future of Ruby documentation
summary
RDoc 8.0 removes old Darkfish aesthetics with the Aliki theme (shipped in Ruby 4.0), replaces the fragile parser with the Prism parser (2,200 → 1,200 lines of code, ~30% faster), and adds real Markdown fixes plus RBS signatures extracted from inline annotations or sig/.rbs files (syntax-validated only). A zero-dependency live preview via --server mode* uses Ruby TCP and a file watcher with ~100 ms latency, and a prototype LLMs.txt flow exports Markdown for agent consumption.
AI-written summary · about
chapters (5)
- 0:00Introduction and background
- 4:25RDoc’s current limitations
- 8:16Recent improvements in RDoc
- 16:45Future plans for RDoc
- 24:39Summary and Q&A
related talks
37mRuby Parser In IRB 20th Anniversary...Now Let Time Resume
35mThe struggle for better documentation for Ruby itself
41mStop making fool of yourself about documentation
18mThanks, I Made It with Quartodoc
24mEscaping the Curse of Outdated Docs
46mAsciidoctor: because writing docs does not have to suck
32mAbundant with life: docs beyond the wall
21mDocOps: engineering great documentation