Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
helgoboss committed Nov 19, 2024
1 parent 497a658 commit c819d0c
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 24 deletions.
1 change: 0 additions & 1 deletion doc/helgobox/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
* xref:introduction.adoc[]
* xref:installation.adoc[]
* xref:usage.adoc[]
* xref:plug-in.adoc[]
** xref:plug-in/user-interface.adoc[]
* xref:app.adoc[]
Expand Down
3 changes: 2 additions & 1 deletion doc/helgobox/modules/ROOT/pages/app.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
= Helgobox App

See xref:app/user-interface.adoc[].
[quote]
include::partial$app-desc.adoc[]
2 changes: 1 addition & 1 deletion doc/helgobox/modules/ROOT/pages/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ReaPack is a popular 3rd-party package manager for REAPER that makes installing

Please check below system requirements before attempting to install Helgobox!

TIP: A more detailed compatibility table can be found link:https://www.helgoboss.org/projects/helgobox#requirements[here].
NOTE: A more detailed compatibility table can be found link:https://www.helgoboss.org/projects/helgobox#requirements[here].

[[windows]]
=== Windows
Expand Down
12 changes: 8 additions & 4 deletions doc/helgobox/modules/ROOT/pages/introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
= Introduction

link:https://www.helgoboss.org/projects/helgobox[Helgobox] is an instrument plug-in for link:https://www.reaper.fm[REAPER] that unites the products link:https://www.helgoboss.org/projects/realearn[ReaLearn] and link:https://www.helgoboss.org/projects/playtime[Playtime] under one roof.
link:https://www.helgoboss.org/projects/helgobox[Helgobox] is an add-on for link:https://www.reaper.fm[REAPER] that unites the products link:https://www.helgoboss.org/projects/realearn[ReaLearn] and link:https://www.helgoboss.org/projects/playtime[Playtime] under one roof.

In addition to the plug-in, it comes with the xref:app.adoc[], a modern user interface for the Helgobox Instrument.
It runs embedded in REAPER and in the future also as a separate mobile app (iOS, Android).
It consists of two components:

If you want to learn more about the contained products, please refer to the link:https://docs.helgoboss.org/realearn[ReaLearn Reference] or link:https://docs.helgoboss.org/playtime[Playtime Reference].
xref:plug-in.adoc[]::
include::partial$plug-in-desc.adoc[]
xref:app.adoc[]::
include::partial$app-desc.adoc[]

include::partial$product-specific-info.adoc[]
18 changes: 16 additions & 2 deletions doc/helgobox/modules/ROOT/pages/plug-in.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
= Helgobox Instrument Plug-In
= Helgobox Plug-In

See xref:plug-in/user-interface.adoc[]
[quote]
include::partial$plug-in-desc.adoc[]

The plug-in is fired up just like any other VST instrument in REAPER: By adding an instance of it to an FX chain:

. Right-click the empty space in REAPER's track control panel
. Select menu:Insert virtual instrument on new track...[]
. Double-click entry "VSTi: Helgobox - ReaLearn & Playtime (Helgoboss)"

Initially, you see the xref:plug-in/user-interface.adoc[plug-in window].
From there you can open the xref:app/user-interface.adoc[Helgobox App].

include::partial$product-specific-info.adoc[]

It is complemented by the xref:app.adoc[].
4 changes: 3 additions & 1 deletion doc/helgobox/modules/ROOT/pages/plug-in/user-interface.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
= User interface

The Helgobox instrument plug-in's user interface primarily provides the user interface for link:https://www.helgoboss.org/projects/realearn[ReaLearn]. Refer to the xref:realearn::user-interface.adoc[] section of the ReaLearn Reference for details.
The plug-in's native user interface features a plain and simple design.
It is home to link:https://www.helgoboss.org/projects/realearn[ReaLearn], the controller integration tool of Helgobox.
Refer to the xref:realearn::user-interface.adoc[ReaLearn user interface documentation] to learn more about it!

.Plug-in window
image::screenshots/plugin-window.png[]
14 changes: 0 additions & 14 deletions doc/helgobox/modules/ROOT/pages/usage.adoc

This file was deleted.

2 changes: 2 additions & 0 deletions doc/helgobox/modules/ROOT/partials/app-desc.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
A complement to the xref:plug-in.adoc[] which provides a modern user interface.
It runs embedded in REAPER and in the future also as a separate mobile app (iOS, Android).
1 change: 1 addition & 0 deletions doc/helgobox/modules/ROOT/partials/plug-in-desc.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A VST instrument plug-in that deeply integrates with REAPER by using its link:https://www.reaper.fm/sdk/plugin/plugin.php[Plug-in Extensions] mechanism.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
For product-specific information, please consult the link:https://docs.helgoboss.org/realearn[ReaLearn Reference] or link:https://docs.helgoboss.org/playtime[Playtime Reference].

0 comments on commit c819d0c

Please sign in to comment.