Skip to content

Commit

Permalink
#1256 Docs: Move architecture images and add initial Playtime docs
Browse files Browse the repository at this point in the history
  • Loading branch information
helgoboss committed Oct 21, 2024
1 parent 762b3e9 commit d05c62d
Show file tree
Hide file tree
Showing 23 changed files with 166 additions and 62 deletions.
154 changes: 108 additions & 46 deletions ARCHITECTURE.adoc

Large diffs are not rendered by default.

File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion doc/helgobox/modules/ROOT/pages/introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Introduction

link:https://www.helgoboss.org/projects/helgobox[Helgobox] is an instrument plug-in for 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 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.

In addition to the plug-in, it comes with the Helgobox App, 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).
Expand Down
4 changes: 2 additions & 2 deletions doc/helgobox/modules/ROOT/pages/usage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Helgobox is fired up just like any other VST instrument in REAPER: By adding an
Initially, you see the Helgobox instrument plug-in, which primarily provides the user interface for link:https://www.helgoboss.org/projects/realearn[ReaLearn]:

.Plug-in window
image::images/helgobox/screenshots/plugin-window.png[]
image::helgobox/screenshots/plugin-window.png[]

== Show the Helgobox App

Expand All @@ -24,7 +24,7 @@ Each Helgobox instance can display its own App window, embedded into REAPER:
. Press menu:Menu[Show App]

.App window
image::images/helgobox/screenshots/app-window.png[]
image::helgobox/screenshots/app-window.png[]

As an alternative, you can use the convenient btn:[Playtime] button in REAPER's main toolbar. If you don't see it, do this:

Expand Down
6 changes: 6 additions & 0 deletions doc/playtime/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
= Playtime Reference
:experimental:

This reference is written in AsciiDoc and follows the directory conventions of the documentation site generator link:https://antora.org/[Antora].

A good place to start is link:modules/ROOT/pages/introduction.adoc[].
12 changes: 12 additions & 0 deletions doc/playtime/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: playtime
title: Playtime Reference
version: ~
nav:
- modules/ROOT/nav.adoc
start_page: introduction.adoc
asciidoc:
attributes:
# For making menu and button macros work
experimental: true
# For showing prev/next links
page-pagination: ''
2 changes: 2 additions & 0 deletions doc/playtime/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* xref:introduction.adoc[]
* xref:installation.adoc[]
3 changes: 3 additions & 0 deletions doc/playtime/modules/ROOT/pages/installation.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= Installation

See xref:helgobox::installation.adoc[installation instructions for Helgobox], the plug-in that contains Playtime.
14 changes: 14 additions & 0 deletions doc/playtime/modules/ROOT/pages/introduction.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
= Introduction

link:https://www.helgoboss.org/projects/playtime[Playtime] is a modern session view aka clip launcher for link:https://www.reaper.fm[REAPER].
It is part of the link:https://www.helgoboss.org/projects/helgobox[Helgobox] plug-in.

This reference provides a detailed description of Playtime's concepts and functionalities. Use it whenever you need an in-depth exploration of a specific feature or functionality in Playtime.

[IMPORTANT]
====
**If you are a beginner, please use the link:https://github.com/helgoboss/helgobox/wiki/Playtime-Home[Playtime Wiki] instead!**
This reference is targeted at users who are already familiar with the Playtime basics and want to look up specific information. The Wiki is perfect if you are just starting off. It guides you through the very basics and contains links to easily digestible video tutorials.
====
1 change: 1 addition & 0 deletions doc/realearn/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
* xref:introduction.adoc[]
* xref:installation.adoc[]
* xref:key-concepts.adoc[]
* xref:user-interface.adoc[]
** xref:user-interface/main-panel.adoc[]
Expand Down
3 changes: 3 additions & 0 deletions doc/realearn/modules/ROOT/pages/installation.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= Installation

See xref:helgobox::installation.adoc[installation instructions for Helgobox], the plug-in that contains ReaLearn.
8 changes: 4 additions & 4 deletions doc/realearn/modules/ROOT/pages/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
|Last update of relevant screenshots: |`2024-10-20 (v2.16.10)`
|===

link:https://www.helgoboss.org/projects/realearn[ReaLearn] is a versatile controller integration tool for REAPER.
It comes as a core part of the link:https://www.helgoboss.org/projects/helgobox[Helgobox] suite.
link:https://www.helgoboss.org/projects/realearn[ReaLearn] is a versatile controller integration tool for link:https://www.reaper.fm[REAPER].
It is part of the link:https://www.helgoboss.org/projects/helgobox[Helgobox] plug-in.

This reference provides a detailed description of ReaLearn's user interface, concepts, and functionalities. Use it whenever you need an in-depth exploration of a specific feature or functionality in ReaLearn.
This reference provides a detailed description of ReaLearn's user interface, concepts and functionalities. Use it whenever you need an in-depth exploration of a specific feature or functionality in ReaLearn.

[IMPORTANT]
====
**If you are a beginner, please use the link:https://github.com/helgoboss/helgobox/wiki/ReaLearn-Home[ReaLearn Wiki] instead!**
This reference is targeted at users who are already familiar with the ReaLearn basics and want to look up specific information. The Wiki is perfect if you are just starting off. It guides you through the very basics and contains links to easily digestable video tutorials.
This reference is targeted at users who are already familiar with the ReaLearn basics and want to look up specific information. The Wiki is perfect if you are just starting off. It guides you through the very basics and contains links to easily digestible video tutorials.
====
19 changes: 10 additions & 9 deletions doc/svg-gen/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { createSVGWindow } from "svgdom";
import {createSVGWindow} from "svgdom";
import svgjs from "@svgdotjs/svg.js";
const { SVG, registerWindow } = svgjs;

const {SVG, registerWindow} = svgjs;
import * as fs from 'fs';
import * as path from 'path';
import pako from "pako";
Expand All @@ -16,24 +17,24 @@ const stylesheet = fs.readFileSync(path.resolve(script_dir, 'styles.css'));
generate()

async function generate() {
fs.writeFileSync('doc/images/modules.svg', await generateModulesDiagram())
fs.writeFileSync('doc/images/onion-layers.svg', generateOnionLayersDiagram())
fs.writeFileSync('doc/images/components.svg', await generateComponentDiagram())
fs.writeFileSync('doc/images/components-midi-fx.svg', await generateComponentDiagram([
fs.writeFileSync('doc/architecture/images/modules.svg', await generateModulesDiagram())
fs.writeFileSync('doc/architecture/images/onion-layers.svg', generateOnionLayersDiagram())
fs.writeFileSync('doc/architecture/images/components.svg', await generateComponentDiagram())
fs.writeFileSync('doc/architecture/images/components-midi-fx.svg', await generateComponentDiagram([
'role-realtime-general',
'role-realtime-midi-general',
'role-realtime-midi-fx'
]))
fs.writeFileSync('doc/images/components-midi-device.svg', await generateComponentDiagram([
fs.writeFileSync('doc/architecture/images/components-midi-device.svg', await generateComponentDiagram([
'role-realtime-general',
'role-realtime-midi-general',
'role-realtime-midi-device'
]))
fs.writeFileSync('doc/images/components-osc.svg', await generateComponentDiagram([
fs.writeFileSync('doc/architecture/images/components-osc.svg', await generateComponentDiagram([
'role-realtime-general',
'role-realtime-osc',
]))
fs.writeFileSync('doc/images/components-management.svg', await generateComponentDiagram([
fs.writeFileSync('doc/architecture/images/components-management.svg', await generateComponentDiagram([
'role-sync-data',
'role-notify',
]))
Expand Down

0 comments on commit d05c62d

Please sign in to comment.