This help site has been deprecated. Please send your requests to support@rubygems.org

Cannot see Documentation link in my gem

sg97's Avatar

sg97

05 Dec, 2020 07:24 AM

I have published a Ruby gem https://rubygems.org/gems/linux_stat/versions/0.4.0

In version 0.1.1, I can see a link called documentation.
But from version > 0.1.1 I can't see that link. What's wrong?

  1. Support Staff 1 Posted by sonalkr132 on 05 Dec, 2020 09:35 AM

    sonalkr132's Avatar

    Hi sg97,

    sidebar links are now set per version. You can set metadata["documentation_uri"] in your gemspec if you want the link to be shown. https://guides.rubygems.org/specification-reference/#metadata

    when you don't specify and of the metadata URI attributes in gemspec, fallback values are used (not recommended).

  2. 2 Posted by sg97 on 06 Dec, 2020 11:07 PM

    sg97's Avatar

    Hi thanks! I later figured that one out by comparing the version 0.1.1 to 0.1.2 and I saw I commented those links in 0.1.1. I find it quite helpful to just link the rdoc there, otherwise, there's always the homepage linked to github where user can read the readme...

  3. sonalkr132 closed this discussion on 23 Dec, 2020 03:17 AM.

Discussions are closed to public comments.
If you need help with RubyGems.org please start a new discussion.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac