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

[blockly] add help button to OH docs, provide blockly source maps for debugging #1401

Merged
merged 4 commits into from
Jun 3, 2022

Conversation

stefan-hoehn
Copy link
Contributor

  1. Add a help button to the category flyouts that directly opens the respective help page on openhab-docs, e.g. like so

image

This is available for all openhab categories as well as in the list and color category
It will most likely lead the blockly users much quicker to the help pages as the experience in the forum shows that the help link of the context menu of an individual block is easily overlooked.

  1. Allow better debugging for blockly code by resolving the source maps for blockly.

It allows much easier development of further blockly functionality as the debugger will now resolve and show the non-minified javascript code when stepping into it.

To be able to use that, source-map-loader (at least 1.1.3) should be installed via NPM.

Signed-off-by: Stefan Höhn stefan.hoehn@nfon.com
Again big thanks goes to @tweini within the blockly community.

… debugging

Signed-off-by: Stefan Höhn <stefan.hoehn@nfon.com>
Signed-off-by: Stefan Höhn <stefan.hoehn@nfon.com>
@stefan-hoehn stefan-hoehn requested a review from a team as a code owner May 30, 2022 11:20
@ghys
Copy link
Member

ghys commented May 30, 2022

Wrt. help buttons - fair enough, on a phone it would look like this though:

image

Wouldn't it be better to emphasize the blocks first and move the help button to the end?
Also I think simply "Help" is sufficient as you clearly know which category you're on.

Co-authored-by: Yannick Schaus <github@schaus.net>
@stefan-hoehn
Copy link
Contributor Author

stefan-hoehn commented May 30, 2022

I actually wouldn't like to have the button on the end because I am sure it would be overlooked 90% of the time. That was actually my intention that people see it right away. So I'd rather leave it there. I wouldn't mind though, to change them to "Help" only (just wanted to be a bit nicer here ;-) ) - that also makes it shorter then on mobile. I have changed them all to "Help" now.

@relativeci
Copy link

relativeci bot commented May 30, 2022

Job #411: Bundle Size — 10.74MB (~-0.01%).

8e29711 vs 91d5653

Changed metrics (1/10)
Metric Current Baseline
Cache Invalidation 1.37% 24.77%
Changed assets by type (1/7)
            Current     Baseline
JS 8.69MB (~-0.01%) 8.69MB

View Job #411 report on app.relative-ci.com

Signed-off-by: Stefan Höhn <stefan.hoehn@nfon.com>
Copy link
Member

@ghys ghys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright - looks good, thanks for all your valuable (and I believe important!) work on Blockly!

@ghys ghys merged commit f1851e9 into openhab:main Jun 3, 2022
@ghys ghys added this to the 3.3 milestone Jun 3, 2022
@ghys ghys added enhancement New feature or request main ui Main UI labels Jun 3, 2022
@stefan-hoehn stefan-hoehn deleted the blockly_help_entry branch June 4, 2022 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request main ui Main UI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants