panel icon indicating copy to clipboard operation
panel copied to clipboard

Add document that describes integration with / support for Marimo

Open Coderambling opened this issue 7 months ago • 6 comments

Marimo supports Panel. This should be documented on the website. See Discord discussion and PR below for details.

https://discord.com/channels/@me/1211774040448966676/1378602993456255096

https://github.com/marimo-team/marimo/pull/2719

Any ideas where / in which doc this should be mentioned? Or should this be a new doc? What would be the best place for it?

Coderambling avatar Jun 01 '25 17:06 Coderambling

I see it as another how-to guide similar to the ones for vs code and jupyter.

I would welcome a PR.

MarcSkovMadsen avatar Jun 02 '25 04:06 MarcSkovMadsen

Would the following text be acceptable for you @MarcSkovMadsen ?

Text:

Panel support has been added to Marimo at the end of 2024 through a collaboration between the Panel and Marimo teams through merging PR https://github.com/marimo-team/marimo/pull/2719

At a high-level it includes serializing Panel components to JSON, setting up bi-directional communications and registering formatters for HoloViz libraries including Panel components, param.rx and HoloViews plots.

For further details on the integration, please consult the PR.

End text

Add the above text as a section to https://panel.holoviz.org/how_to/notebook/other_nb.html , above the Other environments section at the bottom of that page.

I would prefer this approach for now, as it can be implemented quickly, and will kick-off the discoverability.

An alternative would be to basically copy the text of the PR (which is quite a good description) to that doc, or create a separate doc.

For me the main goal for now is to give Marimo / Panel users a fighting chance to discover that Panel support for Marimo exists by:

-Making it discoverable by searching for "Marimo" within the Panel website

-Creating the page will make the content available to search engines, AI's, etc., so the existence of this becomes discoverable through those channels, so searching / asking for "Panel Marimo" and the like will it least turn up a result.

Ok for you to go ahead with the first approach?

Coderambling avatar Jun 05 '25 02:06 Coderambling

Its ok for me. But I would prefer also adding a how-to Panel-Marimo guide with a step by step guide.

MarcSkovMadsen avatar Jun 05 '25 04:06 MarcSkovMadsen

Yes that's what I would prefer. But I will try to do the above as a first pragmatic step.

Then as a next step someone from Marimo and Panel could work on a How-to at the same level as the other how-to's.

I am also not clear on how road-tested the support currently is. But at least the above will increase the chances of people finding it, trying it, and reporting issues based on their experiences.

Coderambling avatar Jun 05 '25 10:06 Coderambling

Related. If either of those 2 happens, that would be very useful as the basis for a how-to.

https://github.com/marimo-team/learn/issues/64

https://github.com/marimo-team/learn/issues/65

Tangentially related:

https://github.com/marimo-team/learn/issues/42

https://github.com/marimo-team/marimo/pull/2835

Coderambling avatar Jun 05 '25 10:06 Coderambling

Made PR: https://github.com/holoviz/panel/pull/7969

Coderambling avatar Jun 05 '25 21:06 Coderambling