The struggle for better documentation for Ruby itself
summary
Documents for Ruby lack a coherent, discoverable reference: core topics and standard‑library entries sit in alphabetical dumps, depth varies wildly, and change‑log entries are often absent from current docs. Workarounds include submitting small pull requests to the ruby repo, publishing GitHub Pages, and assembling an annotated changelog that already covers 2.6, 2.7, 2.4 and 2.3. A community ruby reference site gathers existing material into a structured reference; incremental fixes merge and improve usability, but full coverage remains unfinished.
AI-written summary · about
chapters (11)
- 0:00Introduction by host
- 1:27Why Ruby documentation matters
- 3:15Problems with current Ruby docs
- 8:12Core concepts poorly documented
- 13:04Comparing Ruby to other languages
- 16:58Impact on community perception
- 21:14How the community can improve docs
- 24:57Challenges in documentation work
- 27:27Ruby Reference project overview
- 31:25Call to action for contributors
- 32:53Q&A and closing remarks
related talks
53mMaking Ruby? The Easygoing Ruby Life
41mStop making fool of yourself about documentation
01h 15mDocumentation in the Era of Concepts and Ranges
01h 02m“How to Write Effective Documentation for C++ Libraries..."
01h 24mWriting Documentation - Practices and Theory
37mRuby Parser In IRB 20th Anniversary...Now Let Time Resume
26mThe future of Ruby documentation
35mThe practical implementation of Documentation as Code