New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Best way for documentation #3

Open

Delft-Open-Hardware opened this issue Oct 5, 2023 · 2 comments

Delft-Open-Hardware commented Oct 5, 2023

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

Options:

Writing it as a .md in github
Writing it in the wiki of the github repo
Open Hardware specific website (Wikifactory, HackaDay.io, Open Hardware repository)
Documentation software (Google Docs, Notion, Wordpress, Docusaurus, BookStack, ReadTheDocs, GitBook)

Any feedback is welcome

Collaborator

Jerzeek commented Oct 5, 2023

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

Member

regerohan commented Oct 5, 2023 •

edited

Loading

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment