RDoc VS Inch

In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.

That turns out to be a pretty common use case for markdown. Github, for example, renders your README.md is part of a git repo's "home" page. It's also common to have tooling that parses specially formatted comments in your source code and produce a documentation bundle, usually as a web page (ex. RDoc, YARD, JSDoc, etc.).

I have an open (draft) documentation PR for RDoc over at GitHub (https://github.com/ruby/rdoc/pull/824) that has six unanswered questions. These are embedded in the committed text itself, and each is labelled as "Reviewers: ...."

If you want to document your whole code base you should check https://github.com/ruby/rdoc

I suspect the fix is to remove_unparseable, and the repository, like the CVE, just hasn't been updated yet.

RDoc We'll use this gem to document our TwitchTag.rb class.

As a 20+-year full-stack veteran (and once-upon-a-time English major), I second this. Even the best writers in literature had editors.

To gamify documentation and review, add a static analyzer that measures documentation coverage to CI. Not sure what your stack is, but for Ruby one I've had success with was Inch: https://github.com/rrrene/inch.