docs: add the streaming webstation migration guide - #128
Open
gantoine wants to merge 1 commit into
Open
Conversation
Moves the migration guide out of the romm repo (docs/STREAMING_MIGRATION.md) and onto the docs site, where users reading about emulator streaming will actually find it. Links relative to the repo now point at the docs pages. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
gantoine
added a commit
to LoneAngelFayt/romm
that referenced
this pull request
Sep 5, 2026
The webstation migration guide belongs in rommapp/docs, where users reading about emulator streaming will find it (rommapp/docs#128). The deprecation warning and the protocol module now link to the published page. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Emulator streaming is moving from one broker container per emulator to a single docker-webstation container running romm-broker (rommapp/romm#4314). The migration guide for that change was written in the app repo as
docs/STREAMING_MIGRATION.md, which is the wrong home for user-facing setup instructions, so this moves it here.using/emulator-streaming-migration.md, nested under Emulator Streaming in the nav.examples/config.example.yml-> Configuration File ->streaming), and the repo-internal preamble about the unrelated v1/v2 UI naming dropped.using/emulator-streaming.md.The removal of the file on the app side ships with rommapp/romm#4314, whose warning log and code comments now point at
https://docs.romm.app/latest/using/emulator-streaming-migration/.Notes for reviewers
using/emulator-streaming.mdandreference/configuration-file.mdstill describe the per-emulator container shape. Their webstation rewrite (theprotocol,subfolder,library_path, andplatformskeys) is deliberately not in this PR, which only relocates the existing guide.Testing
uv run mkdocs build --strict(clean apart from a local-only cairosvg/social-cards warning)trunk fmt && trunk checkAI assistance
This PR was written with AI assistance (Claude Code): the page adaptation, nav wiring, and this description. Reviewed by me before opening.