Skip to content

chore: update llms.txt #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johnmckenna-snd merged 1 commit into from
Jun 23, 2026
Merged

chore: update llms.txt #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions public/llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@

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.

[Welcome](https://docs.sndwrks.com/): Complete documentation home for sndwrks products, guides, and reference material.
[Welcome](https://docs.sndwrks.com/): Complete documentation home page for sndwrks.

## 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 hardware and software that runs your show.
- [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 hardware variants.
- [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 sndwrks local web app and why it runs in a browser.
- [Software: Quick Setup](https://docs.sndwrks.com/products/sndwrks-local/software/quick-setup): Guide to accessing the web app for the first time, configuring the server IP address, and adding devices.
- [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 and configure devices (consoles, processors, sensors, etc.) that the server communicates with over the network.
- [Software: Router](https://docs.sndwrks.com/products/sndwrks-local/software/router): Message routing matrix and sACN 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 macro builder with triggers (OSC, sACN, wall clock, server event), commands (OSC, TCP, UDP, HTTP, email, device integrations), and transformers (delay, rate limit).
- [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 preferences; currently in preview.
- [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 including network settings, e-stop, double-message protection, sACN, syslog, and backup/restore.
- [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.

## Guides

Expand All @@ -33,4 +33,4 @@ sndwrks local is the on-site product: a physical server with a web app that hand
## 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, with human review for accuracy.
- [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.