Add docs badge to README #1000

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
2 participants
Contributor

rrrene commented Feb 25, 2014

Hi there,

this patch adds a docs badge to the README to show off inline-documentation to the casual visitor: Inline docs

It links to Inch Pages, a project that tries to raise the visibility of documentation in Ruby projects. The status page for Formtastic is http://inch-pages.github.io/github/justinfrench/formtastic/

Inch Pages is still in it's infancy, but already used by projects like Reek and libnotify.

What do you think?

Owner

justinfrench commented Apr 1, 2014

Looks like this needs to be rebased or merged against master, but I'm not thrilled with the method of evaluating documentation. It seems to be method based rather than class based. I've poured a heap of effort into documenting high level classes, modules and the small number of public helpers that a user of this library would actively use.

Maybe there's a code smell in there, but it doesn't strike me as a great evaluation of our documentation.

Anyhoo, would likely merge if it applies cleanly, but I'm not going to go out of my way right now. Please re-open if you're still keen to pursue!

@rrrene rrrene referenced this pull request Apr 1, 2014

Merged

Add docs badge to README #1013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment