Skip to content

chore: update documentation for surface integrations#4054

Merged
Julusian merged 3 commits intobitfocus:mainfrom
arikorn:chore_update_surface_integrations_docs
Apr 2, 2026
Merged

chore: update documentation for surface integrations#4054
Julusian merged 3 commits intobitfocus:mainfrom
arikorn:chore_update_surface_integrations_docs

Conversation

@arikorn
Copy link
Copy Markdown
Contributor

@arikorn arikorn commented Mar 30, 2026

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

  • Documentation
    • Clarified Surface Integrations; renamed “Surface Modules” to “Surface Modules / Integrations”
    • Explained how physical devices map to the button grid and added a Configured Surfaces section
    • Improved guidance for accessing surface settings, installing/configuring integrations, and module workflows
    • Enhanced USB/device troubleshooting with device-specific notes (Elgato warning) and adjusted UI wording
    • Updated wording/capitalization for “Stream Decks” and referenced Companion 4.3 surface integration version

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!
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b6edea1d-d174-40a5-b413-9feb1f64cb76

📥 Commits

Reviewing files that changed from the base of the PR and between 3552c3b and 5920f0c.

📒 Files selected for processing (1)
  • assets/linux/README

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Surface concepts & configuration
docs/user-guide/3_config/surfaces.md, docs/user-guide/3_config/settings.md, docs/user-guide/7_surfaces/index.md
Expanded Surfaces docs to explain mapping of physical devices to Companion button grids; added a Configured Surfaces section; linked Surface Integrations from settings; renamed/rewrote Surface Modules page to "Surface Modules / Integrations" and added UI steps for adding/configuring integrations and accessing general surface settings.
Device discovery & troubleshooting
docs/user-guide/3_config/surfaces.md
Updated Rescan/USB troubleshooting guidance to reference the Configured Surfaces list and the right-side settings panel; added an Elgato-specific warning to close the Elgato Stream Deck app before rescanning.
Installation & release notes wording
docs/user-guide/1_getting-started/Installation.md, docs/user-guide/1_getting-started/companion-pi/manual-install.md, docs/user-guide/9_whatsnew/v4-0-0.md, assets/linux/README
Minor capitalization and wording fixes: changed instances of "streamdecks"/"Streamdecks" to "Stream Decks" and updated a reference from Companion 4.2 → 4.3 in the Linux README. No functional changes.

Poem

🎛️ New links and mappings tidy the scene,
Buttons and surfaces now clearly convene,
Rescan with care (Elgato, close your app!),
Settings on the right — just give it a tap,
Docs polished and kind — thanks for the keen! ✨

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately reflects the main focus of the changeset: updating documentation specifically for surface integrations across multiple doc files.

✏️ 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2


ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fcdbb2f8-8193-44de-9dcc-494ddab2856e

📥 Commits

Reviewing files that changed from the base of the PR and between b046c44 and e05eb8a.

⛔ Files ignored due to path filters (1)
  • docs/user-guide/7_surfaces/images/surface-integrations-panel.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • docs/user-guide/3_config/settings.md
  • docs/user-guide/3_config/surfaces.md
  • docs/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)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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)

@Julusian Julusian merged commit fc282e4 into bitfocus:main Apr 2, 2026
7 of 8 checks passed
@github-project-automation github-project-automation bot moved this to In Progress in Companion Plan Apr 2, 2026
@github-project-automation github-project-automation bot moved this from In Progress to Done in Companion Plan Apr 2, 2026
@Julusian Julusian added this to the v4.3 milestone Apr 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants