Publish documentation

[noirbizarre]

Publish documentation

[aelsabbahy]

I'm in full support of this. @petemounce has suggested mkdocs material theme in the past.

I'm open to this contribution and any feedback on how to improve the documentation.

Any suggestions on where this can be hosted?

[petemounce]

I've used GitHub pages with mkdocs-material; that worked fine and well. Haven't used readthedocs.

Totally supportive, happy to code review or pitch in as needed.

Are you familiar with https://diataxis.fr ?

[noirbizarre]

That's great news. I'll submit a PR for MkDocs+Material as soon as possible.
For the hosting, you have 2 choices (in my opinion):

• readthedocs.io
• GitHub pages

It won't change much, except for the URL (but with goss.rocks, it can be hidden) and the way you handle documentation versioning if you want to (it's built-in on readthedocs.io, and it requires a mkdocs plugin for GitHub pages). On readthedocs, build is done by readthedocs, you can configure it using their config file, on GitHub pages, you have to craft your own workflow to publish (this is quite easy). But GitHub pages publication is under changes (GitHub heading toward full workflow instead of the special gh-pages branch deployment).

Do you already have some documentation/branding material (logo, prefered colors...) ?