delftopenhardware / Schistoscope

TU Delft Open Hardware Schistoscope
https://www.tudelft.nl/diagnostics-for-all/projects/schistoscope
CERN Open Hardware Licence Version 2 - Strongly Reciprocal
4 stars 0 forks source link

Best way for documentation #3

Open Delft-Open-Hardware opened 11 months ago

Delft-Open-Hardware commented 11 months ago

There are many platforms for documentation, we could look into the best on for the Schistoscope

Options:

Any feedback is welcome

Jerzeek commented 11 months ago

Prusa has made its own website: https://help.prusa3d.com/ (maybe a bit of Wordpress) Precious Plastic uses Docusaurus: https://community.preciousplastic.com/academy/build SafeCast uses Github Wiki: https://github.com/Safecast/bGeigieNanoKit/wiki/Parts-List OpenFlexture uses GitBuilding: https://build.openflexure.org/openflexure-microscope/v7.0.0-beta1/ Gaudi labs uses Media wiki: https://hackteria.org/wiki/index.php/Hacked_Hard-disc_Centrifuge Opulo uses MaterialforMKDocs: https://squidfunk.github.io/mkdocs-material/ Farmbot uses Docusaurus maybe?: https://express.farm.bot/v1.1/assembly/intro PiKVM uses MaterialforMKDocs: https://docs.pikvm.org/

it seems that everyone is using something differently, but they all seem to support .md files, let's go forward with that

regerohan commented 11 months ago

Although I hate the limitations of MarkDown (Maybe because I'm not an expert). I agree with Jerry, I think it is compatible with most.