verb icon indicating copy to clipboard operation
verb copied to clipboard

Missing "getting started" section

Open mourner opened this issue 10 years ago • 4 comments

The readme says "See the getting started section for details.", but the "getting started" link leads nowhere and there's no such section in the readme. :)

mourner avatar May 08 '15 23:05 mourner

ha, well that's just great. A documentation generator with broken docs. thanks for letting me know!

jonschlinkert avatar May 09 '15 00:05 jonschlinkert

+1

Also, I must say that after reading the README twice, I still don't really understand what verb is going to help me with… ok, it generates doc and it's magical and smells like chocolate, but what exactly do I write? Templates, fine, but what are they filled with? Which parts of the doc do I still need to write? Is verb some kind of replacement to JSdoc? To a README?…

MattiSG avatar Jul 03 '15 15:07 MattiSG

@jonschlinkert I used this a couple of years ago, and the documentation for that was better, with howtos (add changelog) and the .verbrc file :smile:

Did you do a full rewrite of the package?

phun-ky avatar Mar 17 '16 09:03 phun-ky

Did you do a full rewrite of the package?

yes, please see the dev branch. it's almost ready to merge to master. I'm working out some final CLI bugs

jonschlinkert avatar Mar 17 '16 12:03 jonschlinkert