What might better documentation look like?

[randyzwitch]

Given the programmer cost of generating working examples is so low, what might a better folium.streamlit.app example look like?

One option could be to demonstrate that every example in https://python-visualization.github.io/folium/latest/user_guide.html works, another could be adding really impressive usages of streamlit-folium

What say you, internet massive?

[randyzwitch]

Here's Claude's estimation:

Folium Plugins with Explicit Examples in streamlit-folium Docs

Plugin	Example File	Purpose
Draw	examples/pages/draw_support.py	Drawing shapes on map
DualMap	examples/pages/misc_examples.py	Side-by-side map comparison
GroupedLayerControl	examples/pages/grouped_layer_control.py	Organized layer control
VectorGridProtobuf	examples/pages/vector_grid.py	Vector tile rendering
Realtime	examples/pages/realtime.py	Real-time data updates
Timeline + TimelineSlider	examples/pages/timeline.py	Temporal data visualization
ImageOverlay	examples/pages/image_overlay.py	Image overlay on maps

Folium Plugins NOT Explicitly Demonstrated (~32 plugins)

These are available in Folium but don't have dedicated examples in streamlit-folium:

• Antpath - Animated flowing dashed polylines
• BeautifyIcon - Customizable marker icons
• BoatMarker - Boat-shaped markers with heading
• FeatureGroupSubgroup - Nested feature groups
• FloatImage - Floating image on map
• Fullscreen - Fullscreen toggle button
• Geocoder - Address search box
• HeatMap - Heat map visualization
• HeatMapWithTime - Animated heat maps
• LocateControl - "Find my location" button
• MarkerCluster - Clustered markers
• MeasureControl - Distance/area measurement
• MiniMap - Overview mini-map
• MousePosition - Display cursor coordinates
• OverlappingMarkerSpiderfier - Spread overlapping markers
• Pattern - Fill patterns for polygons
• PolygonEncoded - Encoded polygon support
• PolylineEncoded - Encoded polyline support
• PolylineOffset - Offset parallel polylines
• PolylineTextpath - Text along polylines
• ScrollZoomToggler - Toggle scroll zoom
• Search - Search features on map
• SemiCircle - Semi-circle shapes
• SideBySideLayers - Layer comparison slider
• TagFilterButton - Filter markers by tags
• Terminator - Day/night line overlay
• TimestampedGeoJson - Animated GeoJSON
• TimesliderChoropleth - Animated choropleth
• TreeLayerControl - Hierarchical layer control
• WMSTimeDimension - Time-enabled WMS layers

Note: Many undocumented plugins likely work with st_folium() since it renders any Folium map object - they just haven't been explicitly tested/documented. The Draw plugin is special because streamlit-folium captures drawing data and returns it to Python.

[IlyasFardaouix]

I think it's great that we're discussing ways to improve the documentation. One thing that might be helpful is to have a comprehensive example that showcases each of the Folium plugins with explicit examples in the streamlit-folium docs, like Claude's estimation. For instance, we could take a look at the draw_support.py example and see how we can build upon that to create a more exhaustive documentation. Perhaps we could also explore adding more impressive usages of streamlit-folium to the docs. Do you think it would be helpful to start by reviewing the existing examples and identifying areas where we can improve or add more content?

[randyzwitch]

Thanks for stopping by @IlyasFardaouix! Is this something you're personally interested in trying?