Re:Show HN: Instant documentation site for Github projects
by ricardobeat on Wednesday January 25, 2012 @06:25PM
(#3512210)
I prefer all-encompassing READMEs over incomplete scattered documentation.
[ Parent
| on HN ]
Re:Show HN: Instant documentation site for Github projects
by stock_toaster on Wednesday January 25, 2012 @06:35PM
(#3512243)
I think all-in-one-README works well for some things, but some of our projects at work would result in HUUUGE readme files. Not so pleasant if those were a single file. We have started using gollum-site[1] for our stuff that grows beyond a medium size length.
The single-long-readme length issue appears to be alleviated by the nav construction in documentup though. Pretty slick.