Skip to content

Commit 235b2ca

Browse files
authored
Merge pull request #48 from SudoMagicCode/2025/v2-edits
Updates to docs (delays)
2 parents c9b4c07 + f63f717 commit 235b2ca

13 files changed

Lines changed: 1300 additions & 1216 deletions

File tree

‎.github/workflows/deploy.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
- uses: actions/checkout@v3
2323
- uses: actions/setup-node@v3
2424
with:
25-
node-version: 18
25+
node-version: 20
2626
cache-dependency-path: docs/yarn.lock
2727
cache: yarn
2828

‎.github/workflows/test-deploy.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
- uses: actions/checkout@v3
2121
- uses: actions/setup-node@v3
2222
with:
23-
node-version: 18
23+
node-version: 20
2424
cache-dependency-path: docs/yarn.lock
2525
cache: yarn
2626

‎docs/docs/v2/gettingStarted/clientConfiguration/010-configureTheClient.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,3 @@ When you first start the client, you will see the status as `initializing.` To l
1212
Initially, the profile will be set to `Default` — review the next section to learn how to create your own profile.
1313

1414
![Client 002](/img/client-configuration/v2-client-config-002.png)
15-

‎docs/docs/v2/gettingStarted/clientConfiguration/030-usingDelays.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,19 @@ description: "How to use Delays"
66
---
77

88
# Using Delays
9-
10-
Delays are a helpful way to organize your processes and add `delay` to their startup.
9+
Delays are a helpful way to postpone the start of an application. For instance, if we need our `TouchDesigner_Data` processes to start 10 seconds after sudoSignals launches, we can use a `delay`.
1110

1211
![Client Profile Process 004](/img/client-configuration/v2-client-profile-process-004.png)
1312

1413
## Adding Delays
1514

16-
On Configuration tab, the Processes column has a button to `Add Delay`.
15+
We can add a delay by pressing the `Add Delay` button in the Processes column.
1716

1817
![Client Profile Process 004A](/img/client-configuration/v2-client-profile-process-004A.png)
1918

2019
### Adjusting Delays
2120

22-
By default, delays are set to `5 seconds`. Click on the clock icon to adjust the duration of the delay.
21+
By default, delays are set to `0.5 seconds`. Click on the clock icon to adjust the duration of the delay.
2322

2423
![Client Profile Process 005](/img/client-configuration/v2-client-profile-process-005.png)
2524

@@ -30,3 +29,10 @@ A dialog will appear where you can adjust the duration (in seconds).
3029
The placement of the delay can also be adjusted by using the handle icon (left) of the delay card.
3130

3231
![Client Profile Process 005B](/img/client-configuration/v2-client-profile-process-005B.png)
32+
33+
![Client Profile Process 005C](/img/client-configuration/v2-client-profile-process-005C.png)
34+
35+
## Multiple Processes
36+
Delays are also a great way to organize multiple processes. Without delays, sudoSignals will launch all applications on start at the same time. With delays, we can organize our processes to start in a specific order and cadence.
37+
38+
![Client Profile Process 005D](/img/client-configuration/v2-client-profile-process-005D.png)

‎docs/docs/v2/gettingStarted/clientConfiguration/040-settings.md‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,23 @@ The sudoSignals client has addional settings for specifying directories, resetti
1111

1212
![Client Settings 01](/img/client-configuration/v2-client-settings-001.png)
1313

14-
## Port Number
15-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
14+
### Port Number
15+
The port that is used for operational communication between processes.
1616

17-
## Profile Directory
17+
### Profile Directory
1818
The directory location for the client's profiles.
1919

20-
## Log Directory
20+
### Log Directory
2121
The directory location for the client's log files.
2222

23-
## Resetting Defaults
23+
### Resetting Defaults
2424
Pressing the `Reset Defaults` button will reset any changes made on the Settings page.
2525

26-
## Revoking Access
26+
### Revoking Access
2727
Pressing the `Revoke Access` button will revoke the dashboard's access to the client. It will also generate a new token for the Client.
28+
29+
### Save & Quit
30+
31+
In order to apply changes in Settings, sudoSignals must save and quit. Please reopen the application to view any changes you may have applied.
32+
33+
![Client Settings 01](/img/client-configuration/v2-client-settings-002.png)

‎docs/docs/v2/gettingStarted/clientConfiguration/clientConfiguration.mdx‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Client Configuration
3-
sidebar_position: 30
4-
slug: /v2/getting-started/client-configuration
3+
sidebar_position: 3
4+
slug: /v2/getting-started/client-configuration/
55
description: "A step-by-step guide through creating your first installation"
6-
76
---
7+
88
import DocCardList from '@theme/DocCardList';
99

1010
# Client Configuration
@@ -19,4 +19,3 @@ sudoSignals runs as a local process on your Windows computer, and is controlled
1919
---
2020
<DocCardList />
2121

22-
<!-- links -->

‎docs/docs/v2/gettingStarted/clientConfiguration/configureAProcess/configureAProcess.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Configure a Process
33
slug: /v2/getting-started/client-configuration/configure-a-process
4-
sidebar_position: 30
4+
sidebar_position: 25
55
description: "Configuring your Processes"
66
---
77

‎docs/package.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
"write-heading-ids": "docusaurus write-heading-ids"
1515
},
1616
"dependencies": {
17-
"@docusaurus/core": "^3.7.0",
18-
"@docusaurus/preset-classic": "^3.7.0",
17+
"@docusaurus/core": "^3.9.2",
18+
"@docusaurus/preset-classic": "^3.9.2",
1919
"@mdx-js/react": "^3.0.0",
2020
"clsx": "^2.0.0",
2121
"docusaurus-lunr-search": "^3.6.0",
@@ -24,8 +24,8 @@
2424
"react-dom": "^19.0.0"
2525
},
2626
"devDependencies": {
27-
"@docusaurus/module-type-aliases": "^3.7.0",
28-
"@docusaurus/types": "^3.7.0"
27+
"@docusaurus/module-type-aliases": "^3.9.2",
28+
"@docusaurus/types": "^3.9.2"
2929
},
3030
"browserslist": {
3131
"production": [
@@ -42,4 +42,4 @@
4242
"engines": {
4343
"node": ">=18.0"
4444
}
45-
}
45+
}
-355 Bytes
Loading
54.9 KB
Loading

0 commit comments

Comments
 (0)