Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Commits on Jun 28, 2015
  1. @fxn
Commits on Feb 6, 2015
  1. @fxn

    Remove documentation tasks

    fxn authored
    This patch removes the tasks doc:app, doc:rails, and doc:guides.
    In our experience applications do not generate APIs using doc:app.
    Methods may be certainly documented for maintainers, annotated
    with YARD tags, etc. but that is intended to be read with the
    source code, not in a separate website. Then, teams also have
    typically selected topics written down in Markdown files, or in
    a GitHub wiki... that kind of thing.
    If a team absolutely needs to generate application documentation
    for internal purposes, they can still easily write their own task.
    Regarding doc:rails and doc:guides, we live in 2015. We are used
    to go to online docs all the time. If you really want access to the
    API offline RubyGems generates it for every Rails component unless
    you tell it not to, and you can checkout the Rails source code to
    read the guides as Markdown, or download them for a Kindle reader.
    All in all, maintaining this code does not seem to be worthwhile
    As a consequence of this, guides (+3 MB uncompressed) won't be
    distributed with the rails gem anymore. Of course, guides and API
    are going to be still part of releases, since documentation is
    maintained alongside code and tests.
    Also, time permitting, this will allow us to experiment with novel
    ways to generate documentation in the Rails docs server, since
    right now we were constrained by being able to generate them in
    the user's environment.
Commits on Dec 23, 2014
  1. @fxn

    warn about reading guides in GitHub

    fxn authored
    References #18148.
Commits on Jan 13, 2014
  1. @fxn

    updates screenshot data [ci skip]

    fxn authored
  2. @fxn
Commits on Aug 23, 2013
  1. @fxn
Commits on Aug 5, 2013
  1. @fxn

    getting started guide: pass the resource to the URL helper [ci skip]

    fxn authored
    Passing the actual ID is not idiomatic.
Commits on Jan 7, 2013
  1. @fxn
Something went wrong with that request. Please try again.