diff --git a/src/content/docs/concepts/modules.md b/src/content/docs/concepts/modules.md index a9a1944..989c39c 100644 --- a/src/content/docs/concepts/modules.md +++ b/src/content/docs/concepts/modules.md @@ -4,11 +4,11 @@ sidebar: order: 2 --- -Modules are anything that can produce input and/or handle output. They are configured in the `modules` property of the [router config file](/reference/config). +Modules are anything that can produce input and/or handle output. They are configured in the `modules` property of the [router config file](/concepts/config). ## YAML Definition A module YAML block has the following properties -- **id**: user assigned unique identifier that will be used to reference a module instance in a [route](/reference/routes) +- **id**: user assigned unique identifier that will be used to reference a module instance in a [route](/concepts/routes) - **type**: the module type - **params**: optional map for module configuration values. The valid values will depend on the module type diff --git a/src/content/docs/concepts/processors.md b/src/content/docs/concepts/processors.md index bda8425..e3a5f65 100644 --- a/src/content/docs/concepts/processors.md +++ b/src/content/docs/concepts/processors.md @@ -4,7 +4,7 @@ sidebar: order: 4 --- -Processors are anything that create or manipulate messages. They are configured in the `processors` property of an individual [route](/reference/routes). Processors have the ability to change the type of the message flowing through the system so a byte array can come into a `osc.message.decode` processor and a OSC message type will come out of the processor. +Processors are anything that create or manipulate messages. They are configured in the `processors` property of an individual [route](/concepts/routes). Processors have the ability to change the type of the message flowing through the system so a byte array can come into a `osc.message.decode` processor and a OSC message type will come out of the processor. ## YAML Definition A processor YAML block has the following properties diff --git a/src/content/docs/concepts/routes.md b/src/content/docs/concepts/routes.md index f14ec43..78c56d4 100644 --- a/src/content/docs/concepts/routes.md +++ b/src/content/docs/concepts/routes.md @@ -7,8 +7,8 @@ sidebar: Routes take the messages coming from a module and push them out another module. The message can be optionally "processed" with any number of processor steps. ## YAML Definition -- **input**: the id of the [module](/reference/modules) that will provide messages to this route -- **processors**: (optional) array of [processors](/reference/processors) that will be called in order and the result of the previous will be fed to the next processor. +- **input**: the id of the [module](/concepts/modules) that will provide messages to this route +- **processors**: (optional) array of [processors](/concepts/processors) that will be called in order and the result of the previous will be fed to the next processor. - if at any point the output of a processor is `null` the entire route will be terminated (subject to change to support output `null` values?) - an error in a processor step will also result in the route being terminated -- **output**: the id of the [module](/reference/modules) that will consume messages from the route \ No newline at end of file +- **output**: the id of the [module](/concepts/modules) that will consume messages from the route \ No newline at end of file diff --git a/src/content/docs/run/cli.mdx b/src/content/docs/run/cli.mdx index ae277e1..105160e 100644 --- a/src/content/docs/run/cli.mdx +++ b/src/content/docs/run/cli.mdx @@ -14,7 +14,7 @@ import { Steps } from '@astrojs/starlight/components'; - [binaries](https://github.com/jwetzell/showbridge-go/releases/latest) -2. create a config file (see [config](/reference/config/)) +2. create a config file (see [config](/concepts/config/)) 3. run