vaadin/framework

Shortcut documentation is bit outdated and could be clearer

Open

#10,672 opened on Mar 2, 2018

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Java (715 forks)auto 404
Help wantedStaledocumentation

Repository metrics

Stars
 (1,806 stars)
PR merge metrics
 (PR metrics pending)

Description

Website feedback:advanced-shortcuts.html page is unclear about role of Panel and Window. It says that these either "accept" or "can attach" shortcuts actions. But shortcut actions are added to some component. Documentation could clearly say that shortcut actions should be added to Panel or Window. "Currently, the only classes that accept ShortcutActions are Window and Panel." "Notice that the keyboard actions can currently be attached only to Panels and Windows.

The feedback is not 100% correct, but the documentation could indeed get some clarifications.

Contributor guide

Research direction
Update the advanced shortcuts.html page to clarify that ShortcutActions can only be added to Panel and Window components, as stated in the issue. Review the current documentation and make the necessary edits.
Tech stack
java
Domain
frontend
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
GitJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85