panel-components / panel-fast

Panel components wrapping the FAST UI library
BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

What kind of documentation should be provided? #4

Open MarcSkovMadsen opened 3 years ago

MarcSkovMadsen commented 3 years ago

This repository/ package needs documentation.

My take would be to create something different from the example notebooks of Panel HoloViz. It simply takes a long time to develop and maintain.

My suggestion would be to create some kind of autogenerated app that users can use to explore the components. Maybe they can simple write panel_components explore and the app will show. My first iteration on something like this is here https://github.com/MarcSkovMadsen/panel-components/blob/main/src/panel_components/shared/component_explorer/__init__.py

https://user-images.githubusercontent.com/42288570/138342619-da43a647-3812-410e-a1ec-06050e6a2996.mp4