Home → Problems →

docs brokens

• Edit

panozzaj

22 Oct, 2015 07:01 PM

http://www.rubydoc.info/gems/rr/doc/01_test_double.md
http://www.rubydoc.info/gems/rr/doc/02_syntax_comparison.md
http://www.rubydoc.info/gems/rr/doc/03_api_overview.md

These all just spin and then after a few refreshes say: We need your help! We just rolled out our new frameless templates for library docs. If something doesn't look right on your desktop or mobile device, please let us know.

1. Support Staff 1 Posted by lsegal on 22 Oct, 2015 07:22 PM

   

   Hi there,

   The full error is a 404

   Sorry, but we couldn't find the page /gems/rr/doc/01_test_double.md in the rr gem. Are you sure that class, method, or file exists?

   Looking at the file list in the rr gem, it looks like those md files are not actually defined in the project as extra files.

   My guess is you got to those pages via broken links in the README? Lookng at the README.md, I can see usage of relative URLs, which is not a reliable way to link to files. Instead, I would recommend opening an issue on the project's GitHub page to let them know of these broken links and suggest using {file:doc/01_test_double.md} syntax in addition to marking these as extra files via the .yardopts file (you would put - doc/*.md into the .yardopts file).

   • Edit