"API docs" as part of Rails 5

Hi all,

With Rails 5 coming up, are there any conversations or efforts to make
API
documentation (for end users, not for the framework itself) a “first
class
citizen”?

Documenting APIs is hard and keeping it up to date is hard. There are a
number of tools to do this already, but I’ve found that they either:

  1. have to be maintained separately
  2. involve ugly meta code / comments in your codebase
  3. don’t have large communities around them

With Rails 5 offering the “API only” mode, I’m wondering if it would be
useful to approach API documentation as a problem that Rails can solve?

Thanks!

PS, I’ve done a cursory search in Github Issues for this and in this
Google
Group, but don’t see anything relevant. Apologies if I missed something.

This forum is not affiliated to the Ruby language, Ruby on Rails framework, nor any Ruby applications discussed here.

| Privacy Policy | Terms of Service | Remote Ruby Jobs