holoviz/panel

Custom Components examples have bad discoverability

Open

#5,336 opened on Jul 27, 2023

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Python (615 forks)auto 404
good first issuetype: docs

Repository metrics

Stars
 (5,722 stars)
PR merge metrics
 (PR metrics pending)

Description

In spite of having looked at most of the docs many times, only today I discovered this section.

Build Custom Components#

These are some of the best and most complete examples for building custom components.

  • To find these, you need to click How-To > Use Specialized UIs and APIs > Build Custom Components, and then scroll down. If you click on the subsections, the examples are gone.
  • The examples dont appear in the navigation menu.
  • There is https://panel.holoviz.org/explanation/components/components_custom.html, which should maybe link to some of the examples.

I would suggest putting these in a more prominent spot.

Contributor guide

Research direction
Review the current documentation structure for custom components, identify where examples are hidden, and propose a more prominent placement in the navigation or add cross links.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90