Help Needed: Where to Put Ruby Docs?

Burdette Lamar - Apr 10 '20 - - Dev Community

Where, other than in the Ruby project itself, can enhanced Ruby documentation be shared to a broad readership?

(By enhanced, I mean substantially beyond what's in the Ruby doc itself.)

TL;DR

Quite a while back I had the notion to found a GitHub project where I'd write about Ruby. My goals included:

  • Telling examples for everything.
  • Hard-nosed precision (e.g., Hash-convertible objects).
  • Completeness (e.g., all exceptions raised).

Shortly, though, I realized that some of this would represent enhancements to Ruby's own documentation. So, I asked myself, shouldn't it actually be put into the Ruby documentation itself, instead of in a separate (and far less prominent) place? The Ruby doc lives in comments in the Ruby project's code, so that's where the enhancements would go.

Last year I experimented by basically rewriting the documentation for Ruby's ENV object. Happy to say that all that got merged (in small batches) and then released with version 2.7. Here are the before and after versions:

All well and good.

This year I've been working on classes Hash and Array.

I have not, though, been able to get anything (again, in small batches) reviewed and merged. I don't complain about that: Everyone's busy, just like us.

The problem is, I have a huge backlog of documentation now:

  • All 75 methods in Hash.
  • Two-thirds of the 95 methods in Array.

I've stashed all that in my own project, About Ruby. But I don't think that very many in the huge Ruby world will find it there.

So my question is this: Is there someplace else I can put this where people are more likely to find it?

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .