Panel 1.0 Documentation Review

[philippjfr]

Documentation Review

• Remove or fix warning about non-interactivity
• Add JupyterLite links everywhere (Add support for a pyodide extension based gallery holoviz-dev/nbsite#270)
• Add links to deployed versions of how-to examples
• Migrate non-featured gallery examples to reference and how-to materials
• Rewrite gallery index page by hand
• Add links to pyodide converted apps
• Fix conversion of apps with global template

Getting Started

• Installation
  • Move section about developing in different environments into How To (@droumis)
  • Link to how-to sections but assume Jupyter(Lab)
• Get started in 2 minutes (@philippjfr)
  • Display Markdown + Chart or Table
  • Run in website, launch JupyterLite or locally
• Getting started with interactivity (@philippjfr)
  • Reactive based

How-to

• how_to/display
  • JupyterLab Preview
• how_to/apis
  • Find better way to guide people to correct API
    • Function vs. Class
    • Callback vs. Reactive
  • Remove interact (and all mentions of interact from documentation)
• how_to/reactive (@hoxbro):
  • Add section on pn.bind
  • Add section on binding parameters on components
  • Add section on ParamFunction/ParamMethod
• how_to/callbacks/session:
  • Missing on_session_created
• how_to/templates/
  • Update screenshots
• how_to/performance
  • Add section on on_load
  • Add section on defer load
  • [ ]
• how_to/concurrency/load_balancing
  • Fix image
• how_to/integrations/flask
  • Missing
• how_to/template/template_theme
  • Remove

Background

• Organize into sections
• Various items missing in TOC
• Panel and Param
  • Missing
• Panel Communications
  • Missing
• Templates
  • Update

Reference Gallery

• Ensure TOC tree has sections (Generate multi-level TOC for gallery holoviz-dev/nbsite#267)
• Make code pyodide executable (Add support for a pyodide extension based gallery holoviz-dev/nbsite#270)
• Add Image and Vizzu pane thumbnails
• Review Template notebooks

Discovered issues with components

• Ipywidgets, matplotlib, Reacton erroring
• DataFrame: Styling bad in dark mode
• VTK not rendering
• JSONEditor: Ace mode causes huge height
• EditableRangeSlider: Spacing of ... is off (Fix Editable Slider CSS #4625)
• Tqdm: Dark mode color wrong
• Accordion / Card width wrong when not expanded
• Column/Row scroll not working (Add support for scrollable on ListPanel #4624)
• GridSpec: Image still too large
• GridStack: no output for full grid
• Vizzu: broken

Pyodide issues

• HoloViews: SciPy, matplotlib
• Markdown: parser broken (nested ```)
• Matplotlib: ipywidgets extension call breaks
• Streamz: broken
• VTK: pyvista vtk import broken
• Video: Broken

Issues

• Show Source link does not work, e.g., https://pyviz-dev.github.io/panel/how_to/components/add_remove.html give the following link https://pyviz-dev.github.io/panel/_sources/how_to/components/add_remove.md.txt
• Fast Slider is missing the handle, and Tabs look very flat: https://pyviz-dev.github.io/panel/how_to/styling/design.html

[philippjfr]

Closing as most of this is captured in #4695 (or other issues).