-
Notifications
You must be signed in to change notification settings - Fork 321
[plan] Add console package README documenting when to use Bubble Tea list vs Huh Select #23690
Copy link
Copy link
Closed
Labels
Description
Objective
Add a README or inline documentation to pkg/console/ that explains when to use the Bubble Tea list picker (list.go) versus Huh Select form field, so contributors can make informed choices.
Context
From discussion #23683 (Terminal Stylist Analysis): pkg/console/list.go implements a full Bubble Tea interactive list picker. It is the only direct Bubble Tea model implementation outside of Huh. The analysis noted this is a good pattern but lacks guidance on when to prefer one over the other.
Approach
- Add a
pkg/console/README.md(or a prominent doc comment at the top ofpkg/console/console.go) covering:- When to use
console.PickFromList()(Bubble Tea list): long lists with search/filter, programmatic selection without a form context, standalone picker outside a multi-field form - When to use Huh
Select: part of a multi-field form, when you needWithTheme/WithAccessibleautomatically, simpler single-item selection in a wizard flow - Note that both respect
console.IsAccessibleMode()and TTY detection
- When to use
- Optionally add a brief doc comment to the
PickFromListfunction inlist.gocross-referencing Huh Select
Files to Modify
- Create or update:
pkg/console/README.md(preferred) or doc comments inpkg/console/console.go - Update:
pkg/console/list.go(add cross-reference doc comment toPickFromList)
Acceptance Criteria
- Documentation clearly states when to use each approach with concrete examples
-
PickFromListfunction has a doc comment cross-referencing Huh Select - No code changes required — documentation only
-
make agent-finishpasses
Generated by Plan Command for issue #discussion #23683 · ◷
- expires on Apr 2, 2026, 12:14 PM UTC
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Type
Fields
Give feedbackNo fields configured for issues without a type.