ribbit-network-frog-hardware icon indicating copy to clipboard operation
ribbit-network-frog-hardware copied to clipboard

Improve Build a Frog Docs with Gifs and Webpage!

Open keenanjohnson opened this issue 1 year ago • 0 comments

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:

  • Instructions were hosted as a dedicated web page that rendered well on mobile
  • Instructions included a lot of awesome Gifs.

Downsides:

  • Hosting the instructions on Squarespace is not ideal as it creates a "walled garden" meaning only those with access can submit fixes and we loose a lot of the benefits of being an open-source project.

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.

keenanjohnson avatar May 28 '23 19:05 keenanjohnson