Create a documentation website

[marcosparagna-eb]

Something like using github pages and have a nice ui and api documentation!

[iusehooks]

Would like to have a github page with gatsbyjs ?

[vndre]

Hello, thanks for this tool @iusehooks, helps us slowly migrate away from redux :)

I can help with the documentation site, I could built it using GitHub pages + GatbsyJS + Docz if you want, we can also use that time to fix #1 if there anything left still to improve.

[antoniopangallo]

Any help is welcome. Free to open a PR whenever you are done with the Doc. Thanks

[vndre]

Hey guys! I said I would do the documentation... sorry for the delay.

But it's finally here! it should be compatible with github-pages, I recommend creating a Redhooks organization so you can use redhooks.github.io domain.

please check it out at: https://github.com/anskydev/redhooks-docs

feedback is appreciated.

[vndre]

I uploaded a live test version at: http://redhooksdocs.cerberus.ansky.sh/

[antoniopangallo]

I think it is nice, you should open a PR. You have used Gatsby so have look at https://www.gatsbyjs.org/docs/how-gatsby-works-with-github-pages/ . Thanks

[vndre]

Unfortunately I have never added gh-pages to an existing repo. Can you help me understand how I should proceed?

This is what I understand:

1. If you want to use the same repo to host documentation I must push all documentation repo files to a folder in the master branch

2. Gatsby build script will create a docs folder in the master branch

3. you configure Github to use master/docs/index.html as entry point for Pages.

But that mixes both codebases, meaning people that clone this repo will also fetch documentation source files, is it supposed to work like this?

I think the other approach is easier and better separated: using gh-pages package you can build to another repo. You could have all documentation files lying on my repo and use publish script to output built files into this repo gh-pages branch. Thats better IMO, because you wouldn't be fetching all those unnecessary files.