Gem Documentation


#1

When forming a GitHub project into a Ruby gem, there are some complications:

  • The gem’s documentation at RubyDoc.info does not like an image that has a relative file path.
  • The gemspec must specify any additional markdown file that’s needed (as a link target).

Is there a reason not to just set the gem’s documentation URL to the README.md over at the GitHub project?