Skip to content
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.

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

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

Open
keenanjohnson opened this issue May 28, 2023 · 0 comments
Open

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

keenanjohnson opened this issue May 28, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@keenanjohnson
Copy link
Member

keenanjohnson commented May 28, 2023

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 keenanjohnson self-assigned this May 28, 2023
@keenanjohnson keenanjohnson added documentation Improvements or additions to documentation enhancement New feature or request labels May 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant