monome / maiden

web based editor and repl for norns
GNU General Public License v3.0
47 stars 33 forks source link

add lua api doc link #152

Closed ngwese closed 5 years ago

ngwese commented 5 years ago

we need an easy way to pull up the docs from maiden

ngwese commented 5 years ago

additional thoughts to ponder. make json conf which provides links to the wiki in addition to local docs. recognize http links in scripts being edited.

ngwese commented 5 years ago

it's not pretty, the links are hardcoded, and the whole thing needs a refactor but i have made some progress on a quick and dirty popup with links to the main documentation (to be published on monome.org) and the api docs (served locally off the device).

hover over the ? and a little menu link thing appears, clicking either link will open a new tab

image

tehn commented 5 years ago

this is fantastic, thank you!

pq commented 5 years ago

awesome!

maybe consider a little bit of UI to indicate that this is a link that will open a new tab?

a little out of step with the maiden aesthetic but the browser icon convention gets used a bunch to indicate something similar-ish.

image

alternatively, maybe the "..." convention (often used to indicate a dialog will open but maybe close enough?)

image

or maybe a "page" icon of some kind?

image

(sorry, all cribbed from IntelliJ where I'm stuck ATM.)

needless to say, cool beans!

ngwese commented 5 years ago

i went with the easy option for now; specifically "..."

the current implementation which i'm going to merge in looks like this when the pointer (not shown) hovers over the ?:

image

basically:

again this leaves a lot to be desired from an interaction and aesthetic standpoint but it gets the job done for now.

ngwese commented 5 years ago

calling this good enough for now. improvements can be handled as part of a new issue.

pq commented 5 years ago

Looks great! 👍