Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing "getting started" section #51

Open
mourner opened this issue May 8, 2015 · 4 comments
Open

Missing "getting started" section #51

mourner opened this issue May 8, 2015 · 4 comments
Labels

Comments

@mourner
Copy link

mourner commented May 8, 2015

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. :)

@jonschlinkert
Copy link
Member

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

@MattiSG
Copy link

MattiSG commented Jul 3, 2015

+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?…

@phun-ky
Copy link

phun-ky commented Mar 17, 2016

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

Did you do a full rewrite of the package?

@jonschlinkert
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants