canonical / canonical/workshop

Feature request: action description

Open
#938 0 comments 0 reactions 0 assignees View on GitHub
product-feedback
Dominant language
Go
Stars
108
Forks
17
Avg merge
1d 7h
Merged PRs (30d)
40

Description

Today, `workshop actions` will print a list of actions with the related *code* definition. This can be cryptic. It would be very nice if we could somehow add some `help` messages to it, so that we can describe:
- what it does
- what are the expected parameters

That is, in general, allowing the user understand what the point of an action is and how to use it.

Contributor guide

Open the contributing guide

Research direction

Start by locating the implementation of `workshop actions` and how it renders related action code definitions. Inspect existing action declarations and any CLI tests, then determine how help text and expected parameters should be represented and displayed; done means the listing explains what each action does and how to use it.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.