green-reviews-tooling icon indicating copy to clipboard operation
green-reviews-tooling copied to clipboard

[ACTION] Move documentation to a dedicated docs website

Open guidemetothemoon opened this issue 1 year ago • 48 comments

With the deprecation of the design doc all the documentation for the work that's being done in Green Reviews WG is being moved to GitHub. To make it easier to digest all the information, onboard new contributors and in general make the overall documentation more visible and accessible we would like to create a dedicated website where the documentation can live.

The website will be linked to the doc files in this GitHub repo and will populate content accordingly. We're already using Hugo as a static site generator for the TAG ENV website and we can do the same in this case as well. It's easy to set up and we can use the same folder structure and Netlify hosting configuration as we do for the TAG. There are also many templates available that are easily set up and adjusted as we need to.

Below are some suggestions for the docs templates we can use. Please note that things like menu sections and such are adjustable, preview website is just to give you an impression of how the website will look like, but we will adjust as needed content-wise.

  • Doks (my personal favorite😁): https://doks.netlify.app
  • Docsy (the one used by the TAG): https://example.docsy.dev
  • Learn: https://learn.netlify.app/en
  • docDock: https://docdock.vjeantet.fr
  • Geekdoc: https://geekdocs.de/

guidemetothemoon avatar Feb 21 '24 17:02 guidemetothemoon