Add "Understanding dataflow" user guide #5737
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
manzt
changed the title
|
We have https://github.com/marimo-team/marimo/blob/main/marimo/_tutorials/dataflow.py Which could also probably do with a refresh |
manzt
force-pushed
the
manzt/dataflow-docs
branch
from
a79b06c to
be01d70
Compare
marimo provides complementary tools for understanding how data flows through notebooks: dependency explorer, minimap, and reactive reference highlighting. This change documents all three features in a new unified guide titled "Understanding dataflow". The new docs include some images and a video demonstrating each feature, with a table legend adapted from Observable's own docs for the minimap. All dataflow tools are also now cross-referenced throughout the docs.
manzt
force-pushed
the
manzt/dataflow-docs
branch
from
be01d70 to
c058161
Compare
There was a problem hiding this comment.
Very nice documentation!
Small notes:
- Add a link to the dataflow guide to the table on
editor_featuresoverview page - Add dataflow to
mkdocs.yaml
You might also consider adding the variables panel as a subsection in dataflow.md, as another way to understand how data flows across the notebook.
Co-authored-by: Akshay Agrawal <akshay@marimo.io>
Co-authored-by: Akshay Agrawal <akshay@marimo.io>
Oops, seeing |
|
@akshayka I tried to unify language and updated the troubleshooting guide as well with debugging tips / example of minimap + dependency tree viewer |
|
🚀 Development release published. You may be able to view the changes at https://marimo.app?v=0.14.14-dev5 |
marimo provides complementary tools for understanding how data flows through notebooks: dependency explorer, minimap, and reactive reference highlighting. This change documents all three features in a new unified guide titled "Understanding dataflow".
The new docs include some images and a video demonstrating each feature, with a table legend adapted from Observable's own docs for the minimap (but using our design language). All dataflow tools are also now cross-referenced throughout the docs.