search

dwyl / sendemail

💌 Simplifies reliably sending emails from your node.js apps using AWS Simple Email Service (SES)
182 stars 26 forks source link

Create doc site #71

Open newswim opened 7 years ago

newswim commented 7 years ago

Even though the Readme contains most needed information, index.js is already using JSDoc notation, anyone against spinning up a gh-pages branch for jsdoc-generated pages to live? I tested locally, with the default template it looks like this:

screen shot 2017-02-10 at 9 09 13 pm screen shot 2017-02-10 at 9 09 21 pm screen shot 2017-02-10 at 9 09 31 pm
nelsonic commented 7 years ago

@newswim go for it. 👍

newswim commented 7 years ago

I pushed the branch but there will need to be an additional change on the part of the dns, since dwyl.github.io forwards to dwyl.io. May not be worth the can of worms that A records and whatever else might be involved, but in the future this change could mean easier doc sites for the libraries. I'm not sure what the next step should be. Input?

screen shot 2017-02-11 at 2 25 16 am
nelsonic commented 7 years ago

Hi @newswim, yeah dwyl.github.io is: https://github.com/dwyl/dwyl.github.io and http://dwyl.io We could host the docs for sendemail somewhere else or set up the DNS for http://sendemail.dwyl.io ...

newswim commented 7 years ago

I think with the current DNS settings, any site under that falls under the umbrella of the DWYL org will be forwarded to dwyl.io automatically. So, it would have to be hosted somewhere else.

I could see future scenarios where you all might want other webpages or gitbooks taking advantage of the free Github Pages hosting. I can look into this some more. I would anticipate this taking ~an hour to complete, with the possible site downtime while the dns records refresh.