diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 4b9cec4..14b4d79 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,7 @@ blank_issues_enabled: false contact_links: - name: Discord - url: https://discord.gg/tjPd6Q9A + url: https://discord.gg/sUgc3rWUP9 about: For general support, chat, and quick questions, reach us on Discord. - name: Email url: mailto:info@sndwrks.xyz diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c479128..15ce897 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,4 +35,4 @@ instead and we'll find another way to incorporate the feedback. ## Questions -Reach us on [Discord](https://discord.gg/7ZcP5v5kBA) or at info@sndwrks.xyz. +Reach us on [Discord](https://discord.gg/sUgc3rWUP9) or at info@sndwrks.xyz. diff --git a/astro.config.mjs b/astro.config.mjs index 614938d..3b7c16b 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -16,7 +16,7 @@ export default defineConfig({ }), starlight({ title: 'documentation', routeMiddleware: './src/routeData.ts', - social: [{ icon: 'discord', label: 'Discord', href: 'https://discord.gg/7ZcP5v5kBA' },{ icon: 'github', label: 'GitHub', href: 'https://github.com/sndwrks/documentation' }], + social: [{ icon: 'discord', label: 'Discord', href: 'https://discord.gg/sUgc3rWUP9' },{ icon: 'github', label: 'GitHub', href: 'https://github.com/sndwrks/documentation' }], logo: { src: './src/assets/sndwrks-logo.svg' }, diff --git a/public/llms-full.txt b/public/llms-full.txt index 8f27381..d8175a4 100644 --- a/public/llms-full.txt +++ b/public/llms-full.txt @@ -362,7 +362,7 @@ Go ahead and tell the browser it's ok to trust the website. 2. **Find it on the network**
There are two options: Link-local or DHCP.
`Link Local`
If you don't have DHCP or are plugged in directly, this port has a [link-local address](https://en.wikipedia.org/wiki/Link-local_address) assigned of `169.254.1.1`. If your computer doesn't have a link-local address, set one like `169.254.1.99`.
`DHCP`
If you're plugging into the network with DHCP, this port is defaulted to have DHCP enabled and it will (hopefully) an IP address. Use an IP scanner to find the server or look in your DHCP server to see the address. 3. **Open the web app**
Use the IP address from Step 2 (either the DHCP address or `169.254.1.1`) and type that into a browser. -4. **Celebrate?**
You should see the homepage of the server website. If not, well heck. We'd recommend confirming your computer network settings, cabling, and the address in the browser. If you're still having trouble reach out on [Discord](https://discord.gg/tjPd6Q9A) or our [Contact page](https://www.sndwrks.com/contact). +4. **Celebrate?**
You should see the homepage of the server website. If not, well heck. We'd recommend confirming your computer network settings, cabling, and the address in the browser. If you're still having trouble reach out on [Discord](https://discord.gg/sUgc3rWUP9) or our [Contact page](https://www.sndwrks.com/contact). ### Server Homepage @@ -963,7 +963,7 @@ We use [uuids](https://en.wikipedia.org/wiki/Universally_unique_identifier) to i 1. Read the description about the command and its usage. 2. See the Address and sometimes Args. We will put bits that you fill in like this: ``. We also often provide ways to copy the properly formatted address right out of the website. 3. There may be an example to show you how to use this in practice as well. Especially, if there's pieces you need to fill in. -4. If it still isn't making sense, [join our discord](https://discord.gg/tjPd6Q9A) and let us know! You can also make your own adjustments to these docs via Github. +4. If it still isn't making sense, [join our discord](https://discord.gg/sUgc3rWUP9) and let us know! You can also make your own adjustments to these docs via Github. ## Supported OSC Types diff --git a/public/llms.txt b/public/llms.txt index 32856b5..fe600e6 100644 --- a/public/llms.txt +++ b/public/llms.txt @@ -2,35 +2,35 @@ > sndwrks is a live entertainment command center platform combining server hardware and software to route show-control messages, monitor atmospherics, fire macros, and coordinate all departments from a single browser-based interface. -sndwrks local is the on-site product: a physical server with a web app that handles OSC routing, sACN, haze watch, macros, chat, and more. Control is available via a full OSC API over UDP or TCP. +sndwrks local is the on-site product: a physical server with a web app that handles OSC routing, sACN, haze watch, macros, chat, and more. It communicates with consoles, processors, sensors, and other devices over the network using OSC, TCP, UDP, and sACN. -[Welcome](https://docs.sndwrks.com/): Complete documentation home page for sndwrks. +[Welcome](https://docs.sndwrks.com/): Complete documentation home for sndwrks — links to hardware quick start, software quick start, products, guides, and reference. ## Products -- [Overview](https://docs.sndwrks.com/products/overview): Entry point for all sndwrks products with links to hardware and software quick starts. -- [sndwrks local](https://docs.sndwrks.com/products/sndwrks-local/home): Overview of the sndwrks local server product — the on-site show control hub. -- [Server Hardware: Getting Started](https://docs.sndwrks.com/products/sndwrks-local/server-hardware/getting-started): Home page for all server hardware documentation. -- [Server Hardware: What is it?](https://docs.sndwrks.com/products/sndwrks-local/server-hardware/what-is-it): Explains the physical server's role, port types (power, network, peripherals), and redundancy options. -- [Server Hardware: Quick Setup](https://docs.sndwrks.com/products/sndwrks-local/server-hardware/quick-setup): Step-by-step unboxing, power, and first-boot instructions for both the server and server smol. -- [Software: Getting Started](https://docs.sndwrks.com/products/sndwrks-local/software/getting-started): Index of all software documentation sections with links to each feature area. -- [Software: What is it?](https://docs.sndwrks.com/products/sndwrks-local/software/what-is-it): High-level overview of the browser-based web app and why a browser interface was chosen. -- [Software: Quick Setup](https://docs.sndwrks.com/products/sndwrks-local/software/quick-setup): Concise guide to accessing the web app, configuring IP addresses, and adding devices for the first time. -- [Software: Overview](https://docs.sndwrks.com/products/sndwrks-local/software/overview): Describes the show-floor home page and how to pin macro shortcut buttons to it. -- [Software: Devices](https://docs.sndwrks.com/products/sndwrks-local/software/devices): How to add, configure, enable, and delete network devices (consoles, processors, sensors, etc.) that the server communicates with. -- [Software: Router](https://docs.sndwrks.com/products/sndwrks-local/software/router): Message routing matrix and sACN universe routing — wire sources to destinations with optional filters; includes message history audit trail. -- [Software: Macros](https://docs.sndwrks.com/products/sndwrks-local/software/macros): Node-based composable actions combining triggers (OSC, sACN, wall clock, server events), commands (OSC, TCP, UDP, HTTP, email, device integrations), and transformers (delay, rate limit). -- [Software: Haze Watch](https://docs.sndwrks.com/products/sndwrks-local/software/haze-watch): Monitors PM2.5, temperature, humidity, and CO₂ from sensors; fires OSC commands via configurable triggers when particulate levels cross thresholds. -- [Software: Chat](https://docs.sndwrks.com/products/sndwrks-local/software/chat): Simple show-floor team chat with notification settings; currently in preview. -- [Software: Utility](https://docs.sndwrks.com/products/sndwrks-local/software/utility): Built-in network scanner, event log, and syslog viewer for troubleshooting and device discovery. -- [Software: Settings](https://docs.sndwrks.com/products/sndwrks-local/software/settings): All server configuration — power/reset controls, network settings, e-stop, double-message protection, sACN, syslog, and backup/restore. +- [Overview](https://docs.sndwrks.com/products/overview): Entry point for all sndwrks products with links to hardware and software quick starts and sndwrks local documentation. +- [sndwrks local](https://docs.sndwrks.com/products/sndwrks-local/home): Overview of the sndwrks local server product — the on-site hardware and software that runs your show. +- [Server Hardware: Getting Started](https://docs.sndwrks.com/products/sndwrks-local/server-hardware/getting-started): Home page for all server hardware documentation with links to what it is and quick setup. +- [Server Hardware: What is it?](https://docs.sndwrks.com/products/sndwrks-local/server-hardware/what-is-it): Describes the physical server hardware — its role at the center of a show, port types (power, network, peripherals), redundant PSUs, and network port details for both server and smol variants. +- [Server Hardware: Quick Setup](https://docs.sndwrks.com/products/sndwrks-local/server-hardware/quick-setup): Step-by-step unboxing, inspection, and power-on instructions for both the server and smol hardware variants. +- [Software: Getting Started](https://docs.sndwrks.com/products/sndwrks-local/software/getting-started): Index page for the sndwrks local web app with links to all major software sections. +- [Software: What is it?](https://docs.sndwrks.com/products/sndwrks-local/software/what-is-it): High-level description of the browser-based web app — mission control for routing, haze watch, macros, and show monitoring. +- [Software: Quick Setup](https://docs.sndwrks.com/products/sndwrks-local/software/quick-setup): Guide to getting the server web app running — finding the IP, opening the UI, configuring network settings, and adding devices for the first time. +- [Software: Overview](https://docs.sndwrks.com/products/sndwrks-local/software/overview): The show-floor home page of the web app featuring one-tap macro shortcut buttons and instructions for pinning macros to the overview. +- [Software: Devices](https://docs.sndwrks.com/products/sndwrks-local/software/devices): How to add and manage devices (consoles, processors, sensors, etc.) that the server communicates with — the building blocks for routing, macros, and haze watch. +- [Software: Router](https://docs.sndwrks.com/products/sndwrks-local/software/router): Message routing and sACN routing via a crosspoint matrix, including crosspoint filters, sACN universe mapping, and a full message history audit trail. +- [Software: Macros](https://docs.sndwrks.com/products/sndwrks-local/software/macros): Node-based composable show actions combining triggers (OSC, sACN, wall clock, server events), commands (OSC, TCP, UDP, HTTP, email, device integrations), and transformers (delay, rate limit). +- [Software: Haze Watch](https://docs.sndwrks.com/products/sndwrks-local/software/haze-watch): Monitors PM2.5 particulate, temperature, humidity, and CO₂ from sensors and fires OSC commands via configurable triggers to maintain consistent atmospheric levels. +- [Software: Chat](https://docs.sndwrks.com/products/sndwrks-local/software/chat): Simple show-floor chat for the production team, currently in preview, with per-browser notification settings. +- [Software: Utility](https://docs.sndwrks.com/products/sndwrks-local/software/utility): Built-in network scanner, event log, and syslog viewer for troubleshooting and show diagnostics. +- [Software: Settings](https://docs.sndwrks.com/products/sndwrks-local/software/settings): All server configuration — power/reset controls, show information, e-stop, network settings, router ports, sACN, syslog, chat notifications, and backup/restore. ## Guides -- [Using Code to Send OSC](https://docs.sndwrks.com/guides/using-code-to-send-osc): Walkthrough for sending OSC messages programmatically using Python (python-osc) and Node.js (osc.js), including a practical login-item startup script example. -- [UDP vs TCP](https://docs.sndwrks.com/guides/udp-vs-tcp): Explains the difference between UDP and TCP transports, when to use each in show-control contexts, and how the TCP handshake and retransmission work. +- [Using Code to Send OSC](https://docs.sndwrks.com/guides/using-code-to-send-osc): Walkthrough for sending OSC messages programmatically using Python (python-osc) and Node.js (osc.js), including a practical example of triggering a server event on Mac login. +- [UDP vs TCP](https://docs.sndwrks.com/guides/udp-vs-tcp): Explains the difference between UDP and TCP transport protocols in the context of show control — when to use each, how the TCP handshake works, and why OSC typically runs over UDP. ## Reference -- [OSC API V1](https://docs.sndwrks.com/reference/osc-api-v1): Complete OSC command reference for sndwrks local covering global commands (confetti, ping, e-stop), devices, router crosspoints, events, haze watch triggers, macros, and chat over UDP or SLIP-framed TCP. -- [AI Statement](https://docs.sndwrks.com/reference/ai-statement): Describes how sndwrks uses AI (primarily Claude) to assist with documentation generation and proofreading while maintaining human review. +- [OSC API V1](https://docs.sndwrks.com/reference/osc-api-v1): Complete reference for all OSC commands accepted by sndwrks local — covers global controls (confetti, ping, e-stop), devices, router crosspoints, event logging, haze watch triggers, macros, and chat messaging. +- [AI Statement](https://docs.sndwrks.com/reference/ai-statement): Describes how sndwrks uses AI (primarily Claude) to assist with documentation generation, proofreading, and keeping content current, with human review for accuracy. diff --git a/src/content/docs/products/sndwrks-local/software/quick-setup.mdx b/src/content/docs/products/sndwrks-local/software/quick-setup.mdx index e89ac5d..9285520 100644 --- a/src/content/docs/products/sndwrks-local/software/quick-setup.mdx +++ b/src/content/docs/products/sndwrks-local/software/quick-setup.mdx @@ -30,7 +30,7 @@ Go ahead and tell the browser it's ok to trust the website. 3. **Open the web app**
Use the IP address from Step 2 (either the DHCP address or `169.254.1.1`) and type that into a browser. -4. **Celebrate?**
You should see the homepage of the server website. If not, well heck. We'd recommend confirming your computer network settings, cabling, and the address in the browser. If you're still having trouble reach out on [Discord](https://discord.gg/7ZcP5v5kBA) or our [Contact page](https://www.sndwrks.com/contact). +4. **Celebrate?**
You should see the homepage of the server website. If not, well heck. We'd recommend confirming your computer network settings, cabling, and the address in the browser. If you're still having trouble reach out on [Discord](https://discord.gg/sUgc3rWUP9) or our [Contact page](https://www.sndwrks.com/contact). ### Server Homepage diff --git a/src/content/docs/reference/osc-api-v1.mdx b/src/content/docs/reference/osc-api-v1.mdx index 0647dc5..0247d2c 100644 --- a/src/content/docs/reference/osc-api-v1.mdx +++ b/src/content/docs/reference/osc-api-v1.mdx @@ -24,7 +24,7 @@ We use [uuids](https://en.wikipedia.org/wiki/Universally_unique_identifier) to i 1. Read the description about the command and its usage. 2. See the Address and sometimes Args. We will put bits that you fill in like this: ``. We also often provide ways to copy the properly formatted address right out of the website. 3. There may be an example to show you how to use this in practice as well. Especially, if there's pieces you need to fill in. -4. If it still isn't making sense, [join our discord](https://discord.gg/7ZcP5v5kBA) and let us know! You can also make your own adjustments to these docs via Github. +4. If it still isn't making sense, [join our discord](https://discord.gg/sUgc3rWUP9) and let us know! You can also make your own adjustments to these docs via Github.