Ribbit-Network / ribbit-network-frog-hardware

The sensor for the world's largest crowdsourced network of open-source, low-cost, GHG Gas Detection Sensors.
https://www.ribbitnetwork.org/
MIT License
96 stars 26 forks source link

Improve Build a Frog Docs with Gifs and Webpage! #217

Open keenanjohnson opened 1 year ago

keenanjohnson commented 1 year ago

During the recent corporate event for Ribbit, we quickly created this set of Frog Sensor Instructions on Squarespace which greatly improved the "build a frog sensor" experience.

The main benefits:

Downsides:

I believe and think that we should reconcile this set of instructions with the set of instructions we have on Github.

It's possible to host a set of instructions on github that render into a nice webpage.

My main inspiration is https://docs.opulo.io/

They host docs from here: https://github.com/opulo-inc/docs/tree/main using a tool called Material for MkDocs

I believe we should port the gifs and content from the Squarespace into a version of the docs using Material for MkDocs.