doc project update

Courtenay : October 27th, 2006

We're powering ahead on the doc project app. Logins are now implemented with open-id, so you can stop writing mopey poetry on your livejournal, or stop mashing refresh on your technorati page, and login to the caboose rdoc app without a password, no setup, nothin'. We've got some awesome layout and css work on the way, courtesy of Amy Hoy and Christi Balan, and a bunch of useful features, like the infamous, "I'm too lazy or noobish to write this myself" button. One of the big issues that came up at Rubyconf was that most of us don't actually use the docs that much, so we find it hard to determine where the biggest need is. This is where that "flag this doc for improvement" feature will come in handy. The app is nearly ready for public consumption, by which I mean, it's not ready at all, but will be Real Soon Now. You really should email me if you want access to the subversion repo and aren't a cabooser.
Posted by Courtenay Filed in documentation, rails, ruby

7 Responses to “doc project update”

  1. Sam Felder Says:
    October 27th, 2006 at 12:34 PM

    If you need more CSS/ layout work give me a buzz. I’d love to volunteer for the project.

    Thanks for all of your hard work!

  2. Trevor Turk Says:
    October 27th, 2006 at 03:10 PM

    As a Ruby Noobie, I’m really excited about this. I hope there will be a commenting featured like on the PHP documentation. I’ve always found that useful. Can’t wait to start playing with the site!

  3. slumos Says:
    October 27th, 2006 at 05:35 PM

    Sheesh, ask web developers to write documentation and instead they have to write a “doc project app”. In case you guys don’t know, “documentation” is that “content” stuff that “writers” put where you had lorem ipsum. ;-)

  4. Sean Braithwaite Says:
    October 29th, 2006 at 07:03 AM

    I would really like to contribute.

    This may be silly, but i can’t find you’re email on the site, shoot me a message if you’re still looking for contributors.

  5. n--b Says:
    October 31st, 2006 at 02:48 PM

    just out of curiosity, why don’t you guys use the docs? Do you remember everything in the docs? or do you just write your own stuff instead of going looking for something that already does the job?

    It would be nice to know how you exalted ones achieve this state of nirvana ??? (-:

  6. Tim Connor Says:
    November 5th, 2006 at 04:20 AM

    Nearest I can tell Sean, tracking down his email seems to be part and parcel of it, ‘cause I got no response with that either. :) A reference to his leetified name @ gmail is on one of the blog posts about the project. :P

  7. Eliot Says:
    November 8th, 2006 at 05:19 PM

    One feature of the PHP API docs I found worthwhile was the “See also” links for each method. Eg. md5() is cross-referenced to sha1() and crc32(). The links made it a little easier to grok the libraries as a whole.

    I think it would also be useful to have some standard way of notating the return type of every method.

    Thanks for the work.

Leave a Reply

I am a human (check this)

Remember: escape your underscores \_ and indent code at least 4 spaces or incur the wrath of smartypants.