docs(agent-browser): fix RenderMode absent-default (iframe, not ab-screencast) - #337
Open
dormouse-bot wants to merge 1 commit into
Open
docs(agent-browser): fix RenderMode absent-default (iframe, not ab-screencast)#337dormouse-bot wants to merge 1 commit into
dormouse-bot wants to merge 1 commit into
Conversation
Deploying mouseterm with
|
| Latest commit: |
bf36d2b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://65e348bc.mouseterm.pages.dev |
| Branch Preview URL: | https://docs-rendermode-default-ifra.mouseterm.pages.dev |
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.
The
RenderModetype docstring claimed a mode-less surface defaults toab-screencast, but the canonical param resolverresolveRenderMode(browser-surface.ts) returnsiframefor any params without a recognizedrenderMode, andBrowserPanelthen mountsIframePanel. So a persisted browser surface with no explicit mode actually reads as an iframe, not a screencast — the comment described the opposite behavior.This corrects the type-level comment to match the resolver and the spec (
docs/specs/dor-browser.md→ "Canonical Params"). The separateScreenSnapshot.renderModeglyph field just below genuinely does default absent →ab-screencast(SurfacePaneHeader.tsxusess.renderMode ?? 'ab-screencast'for the chip glyph), so I left that comment alone and added a note distinguishing the two defaults to prevent the same confusion recurring.Found during the nightly rolling survey.
No regression test: this is a comment-only change with no runtime behavior. The behavior it now documents is already covered by the browser-surface resolution path.