Skip to content

First-time user feedback #826

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

Closed
dandv opened this issue Jun 25, 2017 · 0 comments
Closed

First-time user feedback #826

dandv opened this issue Jun 25, 2017 · 0 comments

Comments

@dandv
Copy link
Contributor

dandv commented Jun 25, 2017

I'm a JS dev who's used JSDoc before, and I've just learned about documentation.js from an npm module boilerplate. Here's my first encounter with the project.

http://documentation.js.org/ looks neat... okay, this tool will generate HTML docs from my JSDoc, so I can throw together GitHub Pages quickly. So let's click "Getting started" at the bottom.

Landed at https://github.com/documentationjs/documentation/blob/master/docs/GETTING_STARTED.md. It explains JSDoc, which I already know... skim/skip... and the page ends abruptly by talking about FlowType.

How do I actually generate my documentation?!

dandv added a commit to dandv/documentation-1 that referenced this issue Jun 25, 2017
@tmcw tmcw closed this as completed in 32ef5a5 Jun 25, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant