hotscript icon indicating copy to clipboard operation
hotscript copied to clipboard

[Contributions Welcome] Documentation

Open gvergnaud opened this issue 2 years ago • 4 comments

If we want this to be used, we will need to setup a good documentation website. What are the best tools to build technical docs these days?

gvergnaud avatar Feb 13 '23 09:02 gvergnaud

I use Docusaurus, easy to setup all markdown and we can automate delivering to gh-pages with github actions. Almost everyone is using it in open source. And then you can buy a domain for it (hotscript.org, hotscript.io, hotscript.dev are not taken) I can buy one if you want

ecyrbe avatar Feb 13 '23 09:02 ecyrbe

Yep. We use Docusaurus hosted on Netlify for all the Redux docs sites.

Also, we get a domain name via https://js.org .

markerikson avatar Feb 13 '23 15:02 markerikson

in my experience, gh-pages is actually easier to setup. everythings on github, easier to maintain.

ecyrbe avatar Feb 13 '23 15:02 ecyrbe

You can set up a GH Pages with a github action pretty easily with docusaurus.

GavinMeierSonos avatar Mar 21 '23 22:03 GavinMeierSonos