Docs duplicated, listed under Github and also Gems
While stumbling around in the dark figuring out how to load a Gem to Rubygems for the first time, I noticed the Rubygems documentation link to Rubydoc.info for the project was not found. So, thinking this might be necessary, I manually added the associated Github repo to Rubydoc.info.
Later I realized it takes time for the Rubydoc.info entry to be generated from a new Rubygems project. So now there are apparently two copies of the docs out on Rubydoc.info. I am just wondering:
- Does anyone care? Should I try and clean this up?
- If so, is it possible/advisable/proper to remove a Github repo from Rubydoc.info?
Comments are currently closed for this discussion. You can start a new one.
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
Support Staff 1 Posted by lsegal on 20 Mar, 2013 05:24 PM
We can remove the repo, but no, nobody should care. Anybody can decide to re-add your GitHub repository to rubydoc.info, so removing it doesn't buy you much. This isn't considered duplication, because the gem is (and will forever be) locked into the API for the code it was released with, while your GitHub repo should represent the current best state. Some people want to read "latest" docs, and some people want to read specific gem version docs-- we let them do either. Some of our users even use rubydoc as a CI server for their docs (with a GitHub hook), so some repos are generated automatically per commit to test how docs will look before publishing a gem. Similarly, lots of projects are available under /github and /gem alike-- in fact, most gems that are hosted on GitHub were probably generated under /github at some point.
Let me know if you still want to remove it, but remember that anybody can add it back.
Hope that helps.
lsegal closed this discussion on 20 Mar, 2013 05:24 PM.