static doc site generation

[hargasinski]

I think the site is finally in a position to be published. The site is generated in the docs folder (not included in the PR) through npm run jsdoc.

For generating the gh-pages (if you host it through that), I could make a PR for a gh-pages branch, which would just include a package.json similar to this one.

/cc @aearly @megawac

Sample site: http://hargasinski.github.io/async/index.html
Fixes #1083, Resolves #1135, Closes #1191

[megawac]

Mind regenerating with the new logo? #1203 #1204

[megawac]

I'm also not a big fan of the table format for listing parameters. Seems kinda ugly =/

[aearly]

I'd say this is good for now. I was going to create a makefile task that handles generating the docs and pushing to the gh-pages branch.

We can make the parameter tables to look more like text through CSS - that was going to be one of my first tweaks. 😛

[hargasinski]

I think I may have pulled the logo changes from master incorrectly, but everything appears to be working? I opted for storing a copy of the logo in the docs, as opposed to using raw.githubusercontent.com... so that we don't accidentally break it on the site if we decide to move it or something. @aearly if you have ideas for the styling the parameter tables on the site, then I'll leave that part for you. CSS is exactly my specialty 😛. The one thing I like about the tables is that they allow you to quickly scan the info, even if it doesn't look the most appealing.

[megawac]

I'm also not quite satisfied with how our typedefs are currently showign (QueueObject and CargoObject). Not exactly the clearest about what they are or how to use them

[megawac]

Alex, do we want to keep the github readme as is or have it point to the
new site
On Jun 30, 2016 7:02 PM, "Alex Early" [email protected] wrote:

Merged #1202 #1202.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#1202 (comment), or mute the
thread
https://github.com/notifications/unsubscribe/ADUIEJ4rYDTubx6a7dKkUl-gNSuf2VTqks5qREr_gaJpZM4JA0wG
.

[aearly]

Let me get a publishing script in place. Once published we'll want the readme to mainly point to the docs site.

[aearly]

http://caolan.github.io/async/ !!!

[hargasinski]

!! That was fast @aearly! I'm really glad it's live 😄

[ivanseidel]

Hey guys! Witch branch should I make changes to the website? I want to help with a few colors in it.. =)

[megawac]

I believe the main one is async-readme.jpg

[aearly]

We're working on master now.

[Kikobeats]

functional and useful docs examples using jsdocs: http://barbajs.org/docs/

[aearly]

Docs are available here: http://caolan.github.io/async/

[megawac]

@caolan have you seen the new docs?! Also can you update the repos header to include a link to the site?

[caolan]

@megawac I've updated the github header - the docs look great :)