# Gem Documentation

**URL:** <https://metaruby.com/t/gem-documentation/1633>\
**Category:** Ruby Chat\
**Created:** [April 10, 2018, 10:38pm UTC](https://metaruby.com/t/gem-documentation/1633 "2018-04-10T22:38:51Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![BurdetteLamar](https://metaruby.com/user_avatar/metaruby.com/burdettelamar/32/758_2.png) [@BurdetteLamar](https://metaruby.com/u/BurdetteLamar)\
**Post date:** [April 10, 2018, 10:38pm UTC](https://metaruby.com/t/gem-documentation/1633/1 "2018-04-10T22:38:51Z")

</div>

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?