Render Docs in a Webpage

[keenanjohnson]

This change does a few things to improve the documentation experience of building a Frog Sensor.

It adds a step to build the Markdown files as a webpage which includes a nicer table of contents, loads faster, and looks better on mobile. This is implemented using MKDocs Material.

It also removes all the V1->V3 docs and Frog files as those are not really useful any longer.

A preview of the site can be seen here: https://ribbit-network.github.io/ribbit-network-frog-hardware/pr-preview/pr-218/

[github-actions[bot]]

PR Preview Action v1.4.4 :---: Preview removed because the pull request was closed. 2023-06-15 21:47 UTC

[keenanjohnson]

@eaudiffred and @pascaljoly I've been working on this improvement to the docs. It renders the docs into a nice website that you can see a preview of here.

Would love any thoughts if you think this is an improvement!

[keenanjohnson]

Image of the new site:

[keenanjohnson]

And here is a video of the new docs on mobile: https://github.com/Ribbit-Network/ribbit-network-frog-hardware/assets/2559382/403105b8-af76-42e1-a961-63197818f976

[pascaljoly]

Looks great. There seem to be a missing link here: All of the parts from Adafruit can be found in this wishlist: https://ribbit-network.github.io/ribbit-network-frog-hardware/pr-preview/pr-218/1-parts/1-parts/

On Jun 11, 2023, at 1:15 PM, Keenan Johnson @.***> wrote:

Image of the new site: https://user-images.githubusercontent.com/2559382/244967278-b1ad8f43-303f-4550-b5df-bfaa3878a6a2.png — Reply to this email directly, view it on GitHub https://github.com/Ribbit-Network/ribbit-network-frog-hardware/pull/218#issuecomment-1586325051, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEGEMUACAEAWDBVYY2UTFWLXKYRP3ANCNFSM6AAAAAAYSB4M7Q. You are receiving this because you were mentioned.

[pascaljoly]

Another comment: on the printing materials. It would be good to mention about recycled plastic option for the filament Given that the sensors are designed to sit outside, a PETG 3D Printer Filament should be used for all the parts. https://ribbit-network.github.io/ribbit-network-frog-hardware/pr-preview/pr-218/2-3d-printing/2-3d-printing/

On Jun 11, 2023, at 1:12 PM, Keenan Johnson @.***> wrote:

@eaudiffred https://github.com/eaudiffred and @pascaljoly https://github.com/pascaljoly I've been working on this improvement to the docs. It renders the docs into a nice website that you can see a preview of here. https://ribbit-network.github.io/ribbit-network-frog-hardware/pr-preview/pr-218/ Would love any thoughts if you think this is an improvement!

— Reply to this email directly, view it on GitHub https://github.com/Ribbit-Network/ribbit-network-frog-hardware/pull/218#issuecomment-1586323818, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEGEMUHVQQTF65O5EL6YAUDXKYRC7ANCNFSM6AAAAAAYSB4M7Q. You are receiving this because you were mentioned.

[keenanjohnson]

Thanks @pascaljoly ! I've fixed that link and we already have a note on PETG in the 3D printing section:

[keenanjohnson]

Any comments or feedback from you @eaudiffred or do we think this is good to merge?

[eaudiffred]

@keenanjohnson Looks great! I did notice that the BOM link and the 3D printed parts file link are not working.

Overall this is way easier to read and follow along!

[keenanjohnson]

Oh let me check on that. It may be sort of due to how the preview is rendering.

Thanks @eaudiffred !

[keenanjohnson]

Yeah those links are just broken due to the preview plugin I have. I have verified they work locally.

Merging now!