Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Workflow Information Panel in the UI #186

Open
darielnoel opened this issue Jan 8, 2025 · 0 comments
Open

Add Workflow Information Panel in the UI #186

darielnoel opened this issue Jan 8, 2025 · 0 comments
Labels
community Issues focused on community engagement and participation. feature New feature or request playground Pertains to the interactive examples or sandbox environments that allow for testing or playing with UI

Comments

@darielnoel
Copy link
Contributor

Description:
A feature to add an informational panel in the workflow interface to help users understand:

  • The purpose of the workflow.
  • Its input parameters.
  • Expected outputs.

Is your feature request related to a problem?
Users currently lack a simple way to understand what a workflow does or what is required to execute it. This leads to confusion and a steeper learning curve.

Proposed Solution:
Add a "Workflow Information Panel" to the KaibanJS UI. This can be:

  1. A hoverable info icon providing a quick summary.
  2. An expandable/collapsible section displaying detailed descriptions, parameter explanations, and output expectations.

Alternatives Considered:

  • Linking to external documentation for each workflow, but this adds friction.
  • Embedding detailed descriptions directly in YAML/JSON files, which is not user-friendly for non-technical users.

Additional Context:
This feature will make workflows more intuitive and accessible, improving user onboarding and reducing reliance on external documentation.

Thanks @aitorroma :)

@darielnoel darielnoel added feature New feature or request playground Pertains to the interactive examples or sandbox environments that allow for testing or playing with community Issues focused on community engagement and participation. labels Jan 8, 2025
@darielnoel darielnoel added the UI label Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Issues focused on community engagement and participation. feature New feature or request playground Pertains to the interactive examples or sandbox environments that allow for testing or playing with UI
Projects
None yet
Development

No branches or pull requests

1 participant