diff --git a/doc/helgobox/modules/ROOT/images/screenshots/welcome-dialog.png b/doc/helgobox/modules/ROOT/images/screenshots/welcome-dialog.png new file mode 100644 index 000000000..cdbe0b97a Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/screenshots/welcome-dialog.png differ diff --git a/doc/helgobox/modules/ROOT/nav.adoc b/doc/helgobox/modules/ROOT/nav.adoc index d3e968295..0bad62e9d 100644 --- a/doc/helgobox/modules/ROOT/nav.adoc +++ b/doc/helgobox/modules/ROOT/nav.adoc @@ -4,6 +4,7 @@ * xref:key-concepts.adoc[] * xref:plug-in.adoc[] ** xref:plug-in/user-interface.adoc[] +*** xref:plug-in/user-interface/welcome-dialog.adoc[] *** xref:plug-in/user-interface/menu-bar.adoc[] * xref:app.adoc[] ** xref:app/user-interface.adoc[] diff --git a/doc/helgobox/modules/ROOT/pages/plug-in/user-interface/welcome-dialog.adoc b/doc/helgobox/modules/ROOT/pages/plug-in/user-interface/welcome-dialog.adoc new file mode 100644 index 000000000..f2cbdf5c9 --- /dev/null +++ b/doc/helgobox/modules/ROOT/pages/plug-in/user-interface/welcome-dialog.adoc @@ -0,0 +1,57 @@ += Welcome dialog + +This dialog appears once after installing Helgobox and whenever you start the action xref:reaper-actions.adoc#show-welcome-screen[]. + +image::helgobox::screenshots/welcome-dialog.png[width=500] + +== Checkbox "Add Playtime button to main toolbar" + +Lets you enable or disable a button in the main toolbar that starts xref:playtime::introduction.adoc[Playtime]. + +== Error checkboxes + +Like any other complex piece of software, Helgobox might have link:https://en.wikipedia.org/wiki/Software_bug[bugs]. There are roughly two types of bugs: _Subtle_ bugs and _detectable_ bugs. Subtle bugs are very hard to investigate. Detectable bugs, however, are "great" because they contain an error message and give me (the developer) a clue of what went wrong. This clue is crucial because I need it to fix the bug. + +The error checkboxes let you decide what Helgobox does if it detects a _detectable_ bug. Let's say the bug occurs. Here's what happens, depending on your configuration: + +[cols="1,1,4"] +|=== +|Send errors |Show errors | Effect + +|Off +|Off +| +A small btn:[ERR] notification will show up in the REAPER title bar (easy to miss!). When you click it, you will see only very basic information about the error. + +|Off +|On +| +A console window will appear with detailed information about the error and a plea to send this information to the developer manually. + +|On +|Off +| +If you are online, Helgobox will send detailed information about the error to the developer (using the third-party error tracking service https://sentry.io[Sentry], see our https://www.helgoboss.org/privacy-statement[privacy statement]). In addition, a small btn:[ERR] notification will show up in the REAPER title bar. Clicking it will reveal further instructions. + +If you are offline, a console window will appear with detailed information about the error and a plea to send this information to the developer manually. + +|On +|On +| +If you are online, Helgobox will send detailed information about the error to the developer and show a console window with further instructions. + +If you are offline, a console window will appear with detailed information about the error and a plea to send this information to the developer manually. +|=== + +.Recommendation +[TIP] +==== +I recommend enabling both checkboxes! + +Sending the error automatically makes sure that I learn about the error as soon as possible, even without your manual notification (I know that you are busy with other things than reporting errors icon:smile-o[]). It also means that the error message shown in the console gets much smaller, as Helgobox then only shows an error ID instead of the full info. + +Showing the error in the console in addition makes sure that you don't miss that something went wrong and offers you ways how to deal with the situation. In many cases, it helps if I get further information from you, such as instructions how to reproduce the error. +==== + + +IMPORTANT: Unless you have a live situation (in which case it might make sense to ignore errors), please tick at least one of the checkboxes. I can't fix bugs if I don't know about them! Thanks. \ No newline at end of file diff --git a/doc/helgobox/modules/ROOT/pages/reaper-actions.adoc b/doc/helgobox/modules/ROOT/pages/reaper-actions.adoc index 4889b64f3..885ce535e 100644 --- a/doc/helgobox/modules/ROOT/pages/reaper-actions.adoc +++ b/doc/helgobox/modules/ROOT/pages/reaper-actions.adoc @@ -15,8 +15,8 @@ This is likely going to change in the future. For the time being, it can be useful to put a Helgobox instance on REAPER's monitoring FX chain in order to have access to those actions at all times. ==== -Helgobox/General: Show welcome screen:: -Shows the welcome screen that was displayed after the first installation of Helgobox. +[[show-welcome-screen]] Helgobox/General: Show welcome screen:: +Shows the xref:plug-in/user-interface/welcome-dialog.adoc[] that was displayed after the first installation of Helgobox. [[toggle-app-focus]] Helgobox/General: Toggle app focus:: Switches focus between REAPER and the xref:app.adoc[]. diff --git a/doc/playtime/modules/ROOT/images/screenshots/helgobox-welcome-screen.png b/doc/playtime/modules/ROOT/images/screenshots/helgobox-welcome-screen.png deleted file mode 100644 index 62f12591e..000000000 Binary files a/doc/playtime/modules/ROOT/images/screenshots/helgobox-welcome-screen.png and /dev/null differ diff --git a/doc/playtime/modules/ROOT/pages/installation.adoc b/doc/playtime/modules/ROOT/pages/installation.adoc index eb0c864c0..d98a57272 100644 --- a/doc/playtime/modules/ROOT/pages/installation.adoc +++ b/doc/playtime/modules/ROOT/pages/installation.adoc @@ -11,7 +11,7 @@ You can add this button very easily by doing this: . Select menu:Extensions[Helgobox > Show welcome screen] . Check "Add Playtime button to toolbar" -image::screenshots/helgobox-welcome-screen.png[width=500] +image::helgobox::screenshots/welcome-dialog.png[width=500] == Alternatives