Khan / Khan/live-editor

Suggested UI improvements for documentation pop-up positioning

Open
#709 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
776
Forks
180
PR merge metrics
No merged PRs in 30d

Description

Received this on ZenDesk:

"When trying to add a new shape, the parameters of the previous shape are covered up. In order to see the previous parameters, the user must click elsewhere to get the help-text bubble to uncover the previous line of code.

It would be more useful if the help text were either below the current line, to the side, or outside the field-of-view entirely (like at the bottom of the coding area).

In this picture, you can see a sample of how the help-text bubble (black) is covering up the previous parameters which a user might refer to during the current line of code:

![Screen Shot 2019-04-28 at 5 15 57 PM](https://user-images.githubusercontent.com/297042/56906643-8b1ad000-6a57-11e9-931d-bd55d1834dba.png)

"

Putting it below the current line of code is probably the easiest and would cover a large % of situations, especially for new programmers who are most likely to write top to bottom.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the documentation help-text bubble and its positioning logic in the live editor; the issue does not name a file or test. Reproduce the overlap shown in the screenshot, then verify that the bubble no longer covers previous parameters and is positioned below the current line where possible.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.