Lighthouse has a new layout. Prefer the old one? Return to the old layout, and switch back any time from the link at the top of each page.

This project is archived and is in readonly mode.

[PATCH] Replaces relative rdoc links with hyperlinks to the Rails API documentation.

#5415

Fixes the currently broken links in the top level README.
Also makes github render these files nicely as rdoc instead of plain text.
Has the added benefit of referring to a known source on the web in the documentation, instead of generated html files which are likely not present on developer's machines anyway.

This commit does not touch other relative rdoc links, e.g. those in the app generator or inline comments.

Reported by joost baaij · August 19th, 2010 @ 09:46 PM

State: committed
Milestone: none
Assigned to: Xavier Noria Xavier Noria
Importance: Medium

Activity

  1. Xavier Noria
    Xavier Noria
    • Assigned user set to Xavier Noria
    • Importance changed from to Medium

    Good!

    Could these links be relative? The API may also be generated to be read offline, for example with the doc:rails rake task.

    August 24th, 2010 @ 07:29 AM

  2. joost baaij
    joost baaij

    Making the links relative would work for local files, but would break the generated RDoc that you see on Github again.

    As it stands I can't seem to marry both worlds at this time. A tweak to Github's markup library (http://github.com/github/markup/blob/master/lib/github/markup/rdoc.rb) might be needed. I will investigate that and update this ticket.

    August 24th, 2010 @ 10:11 AM

  3. Xavier Noria
    Xavier Noria

    Excellent.

    If there's a conflict the API should win (the current relative links need to be revised anyway because they are not valid).

    August 24th, 2010 @ 10:26 AM

  4. joost baaij
    joost baaij

    I am going to split this problem in two. First fix the broken relative links in the readmes, then make sure github sees them as valid rdoc.

    For the first half, this patch fixes the broken links. It applies to both master and 3-0-stable.

    August 24th, 2010 @ 11:26 AM

  5. joost baaij
    joost baaij

    For the second half of this problem, a fix has already been pushed to the github-markup repo.

    http://github.com/github/markup/commit/f65c5fdad47612d4218b6e37dbfe...

    But it hasn't made it to the gem or GitHub production yet. I will ask them to push out a new version so our README.rdoc render properly.

    August 24th, 2010 @ 12:04 PM

  6. Repository
  7. Repository