or Create a profile

Home → Problems →

docs brokens

's Avatar

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

    lsegal's Avatar

    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).

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:

»

Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

  • New Issue

  • Conversation Started

    A conversation has been started with the Rubydoc.info staff to resolve this discussion.

  • Close the discussion

Private Permissions

This discussion is private. Only you and Rubydoc.info support staff can see and reply to it.

Public Permissions

This discussion is public. Everyone can see and reply to it.

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

Recent Discussions

16 Oct, 2019 03:10 PM fxruby documentation no longer accessible
15 Oct, 2019 10:44 AM prolem with ovirtsdk page openning
11 Oct, 2019 08:43 PM FactoryBot Documentation
10 Oct, 2019 10:25 PM Problem with branches or repo config
26 Sep, 2019 08:48 PM Documentation is not generated for a library

Recent Articles

Broken links (404) to Markdown or text documents
Adding a Project from Github
Adding a Rubydoc.info Post-Receive (Commit) Hook on Github
How do I document my Rails project?
How do I add extra README files to my project?