Skip to content

Commit e7b52f8

Browse files
committed
Merge branch 'main' of github.com:intechstudio/grid-documentation
2 parents d958ea0 + d3a8acd commit e7b52f8

2 files changed

Lines changed: 58 additions & 36 deletions

File tree

docs/guides/grid/grid-basic/1-first-changes.md

Lines changed: 39 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,24 @@ _Please visit [**Grid Editor Web App**](https://grid-editor-web.web.app/) - if y
2828

2929
## Navigating the Editor
3030

31-
Grid Editor has 3 sections, each one responsible for certain functionalities:
31+
At a glance, Grid Editor has 3 visually distinct panels, each with its own purpose:
3232

33-
- <span style={{ color: "orange", fontWeight: "bold" }}>Left panel</span>: Settings, Profilecloud, Packages and MIDI monitor
34-
- <span style={{ color: "blue", fontWeight: "bold" }}>Center panel</span>: Module Interaction
35-
- <span style={{ color: "red", fontWeight: "bold" }}>Right panel</span>: Configuration
33+
- <span style={{ color: "orange", fontWeight: "bold" }}>Left panel</span>: Profile Cloud, MIDI monitor, Package Manager and Preferences on the sidebar
34+
- <span style={{ color: "blue", fontWeight: "bold" }}>Center panel</span>: Module layout in the middle
35+
- <span style={{ color: "red", fontWeight: "bold" }}>Right panel</span>: Configuration of the selected element on the right panel
3636

3737
<ImageLightbox imageSrc={control_main_panels} citation={"Grid Editor breakdown into three main panels"} styling={'w-full max-h-[200px] object-contain'}/>
3838

3939

4040
- <span style={{ color: "orange", fontWeight: "bold" }}>Left panel</span>: Choose between:
4141

42-
- **Profile Cloud** – Manage your saved configurations or upload release workflow profiles.
43-
- **MIDI Monitor** – Check and troubleshoot MIDI messages.
44-
- **Packages** – Activate and use packages, e.g. Profile Cloud, Lightroom.
45-
- <span style={{ color: "blue", fontWeight: "bold" }}>Center panel</span>: Displays your connected or virtual modules. Here you can access pages, interaction tracking mode, and primary module operations.
46-
- <span style={{ color: "red", fontWeight: "bold" }}>Right panel</span>: Used for configuring the module.
42+
- **Profile Cloud** – Manage your saved configurations, browse the creations of others. Load and try new configutaions!
43+
- **MIDI Monitor** – Check and troubleshoot MIDI messages. (You might have to enable this Package in the Package Manager)
44+
- **Package Manager** – Activate and use Packages, e.g. Profile Cloud, Lightroom Classic.
45+
- **Preferences** – Change the Preferences of the Grid Editor software. Enable developer options.
46+
47+
- <span style={{ color: "blue", fontWeight: "bold" }}>Center panel</span>: Displays your connected or virtual modules. Always highlights the selected Element with a grey overlay. Here you can also access Pages, fiddle with interaction tracking and primary module operations.
48+
- <span style={{ color: "red", fontWeight: "bold" }}>Right panel</span>: Shows the configuration of the selected Element. Changing the configuration of the module happens here, one Element at a time.
4749

4850

4951

@@ -57,28 +59,31 @@ You can open and close the left and right panels by clicking their sidebar icon
5759

5860
To start configuring your module, you can either click on a control element (knob, button or fader) within the Center panel or interact with the hardware control element in the physical world. Both of these actions will cause the control element to receive a highlight and its configuration will appear on the right panel.
5961

62+
By default the interaction tracking will track both physical and digital interactions with the module.
6063

61-
### Setting up interaction tracking
64+
#### Setting up interaction tracking
6265

63-
Based on the interaction tracking panel setting, the Editor will change the view of the center panel - whenever you interact with the hardware. Interaction tracking settings:
66+
Based on the interaction tracking panel setting, the Editor will change the active/selected Element - whenever you interact with the hardware. Interaction tracking settings:
6467

65-
- **OFF** mode results in hardware interactions are not being tracked by the Editor, but the MIDI Monitor for example shows changes;
68+
- **OFF** mode results in hardware interactions are not being tracked by the Editor, the only way to change the selected element is to click on it in Editor.
6669
- **Element** mode tracks only control element changes, but not event changes.
67-
- **Event** mode will follow how you interact with the hardware, so a button press will show the button event, an encoder turn will show the encoder event;
70+
- **Event** mode will follow how you interact with the hardware, so a button press will show the button event, an encoder turn will show the encoder event.
6871

6972
<ImageLightbox imageSrc={interaction_settings} style={{height:150+'px'}} citation={'Interaction settings dropdown'}/>
7073

7174

7275

7376
## Creating a configuration
7477

75-
Configuration work happens in the right Configuration panel.
78+
Designing your own configuration is done inside the Configuration panel on the right.
7679
Whenever Grid is plugged into Grid Editor the configuration of the selected/default control element is loaded into Editor from Grid memory and becomes editable.
7780

7881
When you interact with an element, the config panel lets you easily adjust it thorught the **[Action](/category/actions)** blocks.
7982
For example, you can set the Mode, change the Color, and define which MIDI message to send.
8083
You can also add action blocks from Lightroom, Photoshop, or other packages if they are activated in the **[Package Manager](/guides/grid/packages/Packages/)**.
8184

85+
Changes made in Editor have to be manually **Stored** or **Saved** to become permanent.
86+
8287

8388
### Store it!
8489

@@ -91,14 +96,17 @@ You can also add action blocks from Lightroom, Photoshop, or other packages if t
9196
<ImageLightbox imageSrc={primary_module_operations} citation={"The top of the Central Panel showing 2 active changes"} styling={'w-3/5'}/>
9297

9398
### Save it!
94-
Use the **[Profile Cloud](/guides/grid/grid-basic/editor-111/)** to save your profile, so you can recall it anytime and never lose your progress.
99+
Use the **[Profile Cloud](/guides/grid/grid-basic/editor-111/)** to save your configuration, so you can recall it anytime and never lose your progress.
100+
101+
The Cloud stored configurations locally even if you're not logged in, so it's always a good idea to keep saves.
95102

96103

97104
## Changing Grid configurations with Editor
98105

99106
### Minimalist Mode
100107

101-
**Minimalist Mode** provides a simplified view of the Editor. It hides complex actions and keeps only the most basic and frequently used ones visible, so new users can start building without feeling overwhelmed.
108+
**Minimalist Mode** provides a simplified view of the Editor.
109+
Turning it on hides complex Actions and Events, keeping only the essential parts of Editor in focus.
102110

103111
<ImageLightbox imageSrc={minimalist} style={{width:550}} citation={''}/>
104112

@@ -108,18 +116,20 @@ You can turn it on or off in the top-right corner of the Editor window, and it w
108116

109117
While creating your Grid configurations, your main workspace will utilize the following panels:
110118

111-
- <span style={{ color: "red", fontWeight: "bold" }}>Pages</span> tabs - shows the active Page of the Grid module, chaning Page reloads config from Grid;
112-
- <span style={{ color: "blue", fontWeight: "bold" }}>Element function</span> - choose between the element function
119+
- <span style={{ color: "red", fontWeight: "bold" }}>Pages</span> tabs - shows the active Page of your Grid setup, changing the Page reloads config from Grid;
120+
- <span style={{ color: "blue", fontWeight: "bold" }}>Event tabs</span> - each element has its own Events that usually run on user interaction;
113121
- <span style={{ color: "green", fontWeight: "bold" }}>Actions</span> - the basic building blocks of Grid profiles, which can be configured under each Event.
114122

115123
<ImageLightbox imageSrc={config_panel} style={{width:80+'%'}} citation={''}/>
116124

117125
## Events and how to make Grid do things?
118126

119-
Physical interaction with Grid trigger Events. Events make their Action Chains run. Actions in the Action Chain make Grid do things.
127+
1. Physical interaction (e.g. turn a potentiometer)
128+
2. Which causes Grid to trigger Events (e.g. Potmeter Event runs)
129+
3. Events make their Action Chains run (e.g. potmeter triggers MIDI Action)
130+
4. Actions in the Action Chain make Grid do things. (e.g. MIDI Action sends out a MIDI message)
120131

121-
Each Event has its own corresponding triggers, you can't configure these.
122-
Each Event has its own Action Chain, you can configure these.
132+
The configurable part of the process are the Actions under each Event.
123133

124134
<ImageLightbox imageSrc={events } style={{height:100+'px'}} citation={'All events'}/>
125135

@@ -131,7 +141,7 @@ After loading a Page - either by connecting the hardware to a power source or ch
131141

132142
#### The Potmeter, Button, Encoder, Endless Events
133143

134-
The _potmeter_, _button_, _encoder_, Endless events are triggered by your interaction with the hardware, with the specific control elements. Like if you rotate an encoder, the encoder event will be triggered. If you press the button, the button event runs.
144+
The _potmeter_, _button_, _encoder_, Endless events are triggered by your interaction with the hardware, with the specific control elements. Rotating an encoder will cause the encoder event to trigger. If you press the button, the button event runs.
135145

136146
#### The Timer Event
137147

@@ -149,18 +159,19 @@ Looking at the system events, _utility_ event is triggered by pressing the side
149159

150160
### The configured actions run on these events
151161

152-
Each Event can have multiple Actions configured. These Actions are executed in the order they are configured, from top to bottom. At the moment there is a [400 character limit](/wiki/more/char-limit) for each Action Chain for configuration length.
162+
Each Event can have multiple Actions configured. These Actions are executed in the order they are configured, from top to bottom. At the moment there is a [390 character limit](/wiki/more/char-limit) for each Action Chain for configuration length.
153163

154164
The Actions are combinations of Lua functions under the hood on Grid. To learn about action types, check out the [Actions](/category/actions) section.
155165

156166

157-
### Element Mode action block
167+
### Element Mode Action block
158168

159-
Each element have a unique Element Mode avtion blocke, where you can change or flip the Min Max value, use relative or absolute mode, Sensitivity, velocity etc
169+
Each Event has a unique Element Mode Action, where you can change or flip the Min Max value, use relative or absolute mode, change their Sensitivity or Velocity.
160170

161-
### Simple Color action block
171+
### Simple Color Action block
162172

163-
Simple color is simple to use but you can achive complex settings, for example you can add the minimum max and also the middle position color of an element. [More about the Simple Color...](/wiki/actions/led/simple-led-color/)
173+
Pick a color that you like or add more colors to the mix with Simple Color.
174+
Simple Color is simple to use but you can achieve complex settings, for example you can add the minimum max and also the middle position color of an element. [More about the Simple Color...](/wiki/actions/led/simple-led-color/)
164175

165176
### The Message Action Block
166177

@@ -180,7 +191,7 @@ If you use the **MIDI Action Block**, you can check your messages in the **MIDI
180191

181192

182193

183-
<ImageLightbox imageSrc={check_midi_monitor} citation={'Delete the variable with the "x" and hard-code the values in the MIDI Action block'} styling={'w-3/5 object-contain'}/>
194+
<ImageLightbox imageSrc={check_midi_monitor} citation={'Showcasing MIDI messages in the MIDI Monitor sidepanel'}/>
184195

185196

186197
## Completing a configuration

docs/guides/grid/grid-basic/config-quick.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_position: 2
3-
title: "1.1: Configurate quicker"
3+
title: "1.1: Editor tips and tricks"
44
description: Often used practices and tools explained
55
slug: config-quicker
66
---
@@ -13,13 +13,13 @@ import element_act from './config-quick-img/element_act.png';
1313
import ab_op from './config-quick-img/ab_op.png';
1414

1515

16-
### Add Block and Cahnge the Order
16+
## Adding Actions in different ways
1717

1818
Adding a block is possible in different ways:
1919

20-
- Use the **Add Action Block…** button to add an action block to the bottom of the element.
21-
- Or select the exact place where you want to insert an action block.
22-
- You can drag and drop an Action Block to change its order or move it to another element.
20+
- Use the **Add Action Block…** button to add an action block to the __bottom of the chain__.
21+
- Or __select the exact place__ by moving the cursor between Actions.
22+
- You can __drag and drop__ an Action Block to change its order or move it to another element.
2323

2424

2525
<div style={{ display: 'flex', gap: '1rem', alignItems: 'flex-start' }}>
@@ -31,10 +31,19 @@ Adding a block is possible in different ways:
3131

3232

3333

34-
### Navigating and Using Elements Operations
34+
## Navigating and Using Element and Action Operations
3535

36-
You can select an element in the module and navigate using the arrow keys.
37-
If you want to duplicate the configuration of one element to another, you can use the standard shortcuts: **Cmd/Ctrl + C** to copy and **Cmd/Ctrl + V** to paste.
36+
### Navigating the Editor
37+
38+
You can select an element in the module and navigate using the arrow keys. You can also use the Tab key to move the cursor around.
39+
40+
:::tip
41+
Keep in mind that each panel will indicate if its in focus and each Operation will act in different ways depending on which panel is on focus!
42+
:::
43+
44+
### Element Operations
45+
46+
If you want to duplicate the configuration of one element to another, select the Element on the Grid layout panel in the middle and then **Cmd/Ctrl + C** to copy and **Cmd/Ctrl + V** to paste it to another selected Element.
3847

3948
You can also use the icons to:
4049
- <span style={{ color: "green", fontWeight: "bold" }}>Copy</span> – Duplicate the element data to the clipboard.
@@ -44,6 +53,8 @@ You can also use the icons to:
4453

4554
<ImageLightbox imageSrc={element_act} style={{ height: '200px' }} citation={'Element Actions'} />
4655

56+
All of theses Operations are also available by right-clicking the element on the Grid layout panel.
57+
4758
### Action Block Operations
4859

4960
When selecting one or more Action Blocks, you can perform the following actions:

0 commit comments

Comments
 (0)