chore: update documentation for surface integrations#4054
chore: update documentation for surface integrations#4054Julusian merged 3 commits intobitfocus:mainfrom
Conversation
I have to admit to still being confused about Surface "Modules" vs "Integrations" -- particularly in how the documentation refers to it. There was essentially no use of the word "Integrations" in the docs prior to this PR and, frankly, I'm not sure I'm doing it right!
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation clarifies Surface Integrations and surface configuration across the user guide: adds links and UI instructions, expands Surfaces to describe physical device mappings and configured surfaces, updates Rescan/USB troubleshooting with an Elgato-specific note, and fixes capitalization of "Stream Decks." Changes
Poem
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: fcdbb2f8-8193-44de-9dcc-494ddab2856e
⛔ Files ignored due to path filters (1)
docs/user-guide/7_surfaces/images/surface-integrations-panel.pngis excluded by!**/*.png
📒 Files selected for processing (3)
docs/user-guide/3_config/settings.mddocs/user-guide/3_config/surfaces.mddocs/user-guide/7_surfaces/index.md
applied its "Stream Deck" advice (two words) globally to the docs, additional copyedits courtesy of local rabbit and Claude.
| #### Remote USB | ||
|
|
||
| To connect streamdecks to companion from another machine, you can use [Companion Satellite](https://github.com/bitfocus/companion-satellite) | ||
| To connect Stream Decks to companion from another machine, you can use [Companion Satellite](https://github.com/bitfocus/companion-satellite) |
There was a problem hiding this comment.
| To connect Stream Decks to companion from another machine, you can use [Companion Satellite](https://github.com/bitfocus/companion-satellite) | |
| To connect Stream Decks or other surfaces to Companion from another machine, you can use [Companion Satellite](https://github.com/bitfocus/companion-satellite) |
This PR adds a fair bit of details and fixes links related to Surface Integrations
I have to admit to still being confused about Surface "Modules" vs "Integrations" -- particularly in how the documentation refers to it. There was essentially no use of the word "Integrations" in the docs prior to this PR and, sorry to say, I'm not sure I'm doing it right!
Summary by CodeRabbit