Feedback on docs

[Ben-Epstein]

Setup and install (mac)

This start screen adds friction. If you already know they are on mac, you should suggest quickstarts here for installation.

brew install node 
brew install [email protected]

And then offer a link for other options. Just keeps things moving quickly

Getting started

After installation, taking me to “Camera” is confusing and a bit intimidating.

Instead, you should take me to a page called “First Steps” that lays out:

• Flojoy Architecture
• Common terms (what is a “node” for example)

Something like this Introduction page](https://docs.flojoy.io/nodes/introduction/)

After the “First steps” page (and an optional glossary of terms) you should take me to a page called "Your first Flow” and walk me through a simple example that leverages different components and ends me at a working example.

Introduction Page

ref

This page is a good start, but it could be tuned a bit. Instead of having boxes on the single page and then referencing them by color (this green box does X, the yellow does Y…), you can have a small picture under each bullet point that is zoomed in/focused on that particular feature. I have an example of that in my Solara app that people seem to react well to.

Not sure what this means exactly

You are also reusing colors which makes this more confusing:

This

Is referring to a different control than this

First Example

ref

Right at the top, you should give me a brief overview of what this app is doing, and let me know that we’re going to walk through each piece step by step. When reading this i was overwhelmed by the UI that i was scrolling through the page just to see if you were planning to walk me through it. A short description would be really helpful.

This part very confusing. Why include an example project if we’re not going to use it and walk through it? You should use this page to walk me through the sample flow, then in a new page in the docs help me build my own.

Controls Docs

ref

It says “SINE has 5 controls"

But then it says this. These feel inconsistent.