How-to Review

[droumis]

Addresses #4444

TODO:

General

• Reorganize the highest level of How-to as to not mix thematic/topic-based sectioning with difficulty-based sectioning (e.g. having both an 'Exporting and Saving Output' section and 'Advanced' section on the same level. Currently on hold as there is still some consensus to be sought on this issue. update.. new organization proposed and agreed upon.
• Review section and subsection card phrasing for consistency
• Review card octicons for accuracy and discriminability
• Why don't horizontal lines appear in the docs with ---?
• Do all how to page titles match their card titles?
• add components/index to the how to index toctree
• review TOC's

Basics

Choose an API:

• This subsection is very important but it is broad and teaching-oriented and therefore it fits much better in the Background. If there are certain aspects of this material that are crucial for all Panel users to learn, then we should incorporate them into the Getting Started Guide (either Core Concepts or expand/create an additional Tutorial).
• List Param guides before Links in the index
• Add a subsection about "Building UIs with the Reactive API"

Create Components

Initialize Components

• add toctree to index

Construct Panes, Access Pane Type, Access Widget Values

• Add problem statement
• replace See Also admonition with Related Resources

Add or Remove Components

• Reduce size of 'some text' markdown in app example
• add complete copyable block of code at the end of subsections
• Fix warning about background
• Add problem statement
• replace See Also admonition with Related
• Add link to GridSpec reference gallery

Style Components

Apply CSS

• Add problem statement
• Add related resources
• Add a complete copyable block at the end
• Add resource link to 'Apply Templates' How-to's

Change Background

• Remove this how-to since background is now just another parameter, instead of having to explain the styles dict handling

Customize Loading Icon, Control Visibility

• Fix warning about background
• Add problem statement
• Add related resources

Arrange and Size Components

Customize Spacing, Align Components, Control Size

• Fix warning about background
• Add problem statement
• Add related resources

Declare UIs with parameters

• Edit title to include 'Param' and 'API', e.g. "Declare UIs with the Param API"
• Capitalize all references to Param's "Parameters" or "Parameterized" objects
• Fix bad link to 'Declare Parameter dependencies'
• Add octicons for each guide card

Building UIs using Param

• change title to "Generate widgets from Parameters."
• Add related resources
• Include link to background page on Param API
• Fix WARNING:param: Setting non-Parameter class attribute BaseClass.int_list = [1, 7]
• Add problem statement
• Add prerequisite on Param docs
• File issue about multifileselect spacing

Declare Custom Widgets

• Replace text mentions about 'previous sections' with prerequisites
• Add label to first subsection
• Add related resources
• Add problem statement
• Add prerequisite on How to > Building UIs using Param

Declare Parameter Dependencies

• Add related resources
• Add problem statement
• Rewrite to make it more task-oriented
• Add prerequisite on How to > Building UIs using Param

Param Subobjects

• Make title into how to ...
• Add prerequisites on How to > Building UIs using Param
• Add prerequisites on How to > Declare Parameter Dependencies
• Add related resources
• Add problem statement

Link Parameters

• edit title to reflect that this is related to the Callbacks API: e.g. "Link parameters with the Callbacks API"
• remove reference to another section in the intro text; revise
• Add octicons for each guide card
• The dissociation of .jslink, js_on_click, and jscallback is not clear enough.. need to reorganize/rewrite these JS how-to's

Watchers

• make title in to how to...
• remove reference to 'previous' guide
• Add related resources
• Add problem statement
• change references of param.watch to .watch
• remove reference to subsequent guide sections
• revise into how-to recipes (and potentially some Background)
• Add prerequisites on How to > .link guide

Links in Python

• Add related resources
• Add problem statement

Links in Javascript

• Remove references to 'link example above' and artifacts like that
• Add related resources
• Add problem statement
• Add link to linking plots with jslinks
• Make title into how to...
• change pyviz to holoviz in URL example
• Move URL example on js_on_click to the javascript callbacks how-to

Link plots in Javascript

• fix wrong link to guide
• Add related resources
• Add problem statement
• Add prerequisite for other jslink page
• make title into how to ...

Javascript callbacks

• Add related resources
• Add problem statement
• make title into how to ...
• distinguish title from 'links in javascript' how to

Interact with Functions

• edit title to reflect that this is related to the Interact API: e.g. "Build UIs with the Interact API"
• fix octicons for each guide card

Generate Widgets for Function Arguments

• add link to reference
• fix use of style = ...background
• Add 'let's put it all together:' at end

Customize Layout with Interact

• add link to reference
• add prerequisite for 'generate widgets with interact..'

Fix Values with Interact

• add link to reference
• add prerequisite for 'generate widgets with interact..'

Disable Continuous Updates with Interact

• add link to reference
• add prerequisite for 'generate widgets with interact..'

Apply Templates

Set a Template
Arrange Components in a Template

• add prerequisite for setting a template

Toggle Modal

• add prerequisite for setting a template

Customize Template Theme

• add prerequisite for setting a template

Build a Custom Template

• add a heading for the first section
• add prerequisite for setting a template
• add prerequisite for customizing a template theme

Build a Pipline

• make section card text 'how to ...'
• Remove 'initialize components' heading from subsection index

Create a Pipeline

• Add complete copyable code block

Create a Non-Linear Pipeline

• Add complete copyable code block

Customize Pipeline Layout
Control Pipeline Flow

• Add complete copyable code block

Build Custom Components

• make section text consistent in style with others
• Make the how-to's more recipe-like, and the background more explanation.. right now there is a lot of overlap

Combine Existing Components

• remove rogue parentheses

Build Components from Scratch

• make the associated background page a prerequisite
• Fix link to background > external dependencies

Display and Export

• redistribute section into build and share sections

Display Components and Apps

• Move into Build Apps section

Display Output in Notebooks

• Add problem statement
• Add related resources

Develop Apps in an Editor

• needs to be written

Develop Apps in JupyterLab

• rename to 'Preview apps in jupyterlab'
• needs to be written

Improve Performance

• make octicons different

Register Session Callbacks

• Add problem statement for all guides
• Add related resources heading for all guides

Asynchronous Callbacks

• rename to how to ... format
• add warning admonition for the python version
• fix "ModuleNotFoundError: No module named 'aiohttp'" when rerunning the pyodide extension

Load Callbacks

• fix bad link
• fix bad grammar

Access Session State

Cache Data

Improve Performance

Improve Scalability

Enable Profiling and Debugging

Set up testing for an application

Server Configuration and deployment

Configure the server

Integrate with other Servers

Deploy Applications

Add Authentication

Export and Save Output

• Add cards to the index for individual pages
• rename to how to..
• Move to new "share" section that generalized 'Deploy and Export;

Embedding State

• rename to how to..
• Add problem statement
• Add related resources

Saving

• rename to how to..
• Add problem statement
• Add related resources

Bokeh

• rename to how to..
• Add problem statement
• Add related resources

Run Panel in WebAssembly

[codecov]

Codecov Report

Merging #4445 (b4d220d) into main (0cf1c5b) will decrease coverage by 0.07%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #4445      +/-   ##
==========================================
- Coverage   81.80%   81.74%   -0.07%     
==========================================
  Files         238      243       +5     
  Lines       34872    35234     +362     
==========================================
+ Hits        28528    28801     +273     
- Misses       6344     6433      +89     

Flag	Coverage Δ
ui-tests	35.72% <ø> (-0.24%)	⬇️
unitexamples-tests	73.59% <ø> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
panel/widgets/debugger.py	84.84% <0.00%> (-7.58%)	⬇️
panel/template/golden/__init__.py	84.61% <0.00%> (-6.30%)	⬇️
panel/io/resources.py	81.36% <0.00%> (-3.26%)	⬇️
panel/config.py	56.97% <0.00%> (-2.88%)	⬇️
panel/io/document.py	51.42% <0.00%> (-2.74%)	⬇️
panel/template/vanilla/__init__.py	91.66% <0.00%> (-2.46%)	⬇️
panel/io/reload.py	71.73% <0.00%> (-2.18%)	⬇️
panel/tests/util.py	90.09% <0.00%> (-1.81%)	⬇️
panel/layout/accordion.py	87.61% <0.00%> (-1.49%)	⬇️
panel/models/tabulator.py	96.34% <0.00%> (-1.28%)	⬇️
... and 54 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[philippjfr]

@droumis I'm trying to build the docs and would like to include the latest versions. So I'm going to merge this PR and then migrate your excellent comment tracking your progress into an issue.