Repository navigation
docs(fleet): document the camera panel where its controls live - #47
Merged
Merged
Conversation
Stream Settings, the stream selector and the audio controls are all the header of the dashboard's Camera Feeds panel — teleop has no stream selector at all and opens the same dialog on a different tab — so the teleop page owned the smaller half of what it was describing. The dashboard now carries both, and teleop keeps Take Voice and links out for the rest. Enabling a stream gets taught before the layout does, because a pane assigned to a stream that is not running stays empty and nothing on either page said so.
A supplied screenshot carried a red highlight box marking the control to write about; publishing it would have put the only annotated figure on the site, so it was reconstructed clean and the recovery method is worth keeping. The second is the reverse case — fleet-stream-settings.png was captured against a robot with no streams, which only became a defect when the figure moved under prose about enabling them. The recapture goes in TODO.
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
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.
Moves Arranging the view and Audio from
robot-teleoperation.mdtorobot-dashboard.md, and adds the step that was missing from both: enabling a stream.Why
The whole control cluster — the audio toggle, Take Voice, the stream selector and the Settings button that opens Stream Settings — is the header of the dashboard's Camera Feeds panel. Teleop has no stream selector at all, and the settings dialog it opens is the same dialog on a different default tab. The teleop page owned the smaller half of what it was describing.
Setting a pane layout starts nothing. A pane assigned to a stream that is not running reads Waiting for stream…, and neither page said so — so the enabling step is now taught before the layout step rather than implied by it.
What changed
robot-dashboard.md— new Arranging the view (split into Which streams are running and How the panes are arranged) and Audio sections, plus two FAQ entries. The settings table gains a Primary stream row that was missing.robot-teleoperation.md— keeps a teleop-shaped Audio section, since Take Voice is on the teleop bar; Arranging the view becomes a short pointer.index.md, both frontmatter descriptions and the cross-links updated in the same pass, so nothing still routes these topics at the old page.solution/img/fleet-stream-selection.png— new figure.Notes for review
The screenshot was published without the red highlight it arrived with. No figure on this site is annotated, so the marked-out pixels were reconstructed from the surrounding UI geometry; exactly the 7,223 marked pixels changed and no others.
fleet-stream-settings.pngwas captured against a robot reporting no streams, so its Enabled Streams list is an empty heading. Harmless while the figure only illustrated layout, not harmless under a section about enabling streams — the caption now says why, and the recapture is logged inTODO.md.Claims about roles, leases, persistence and the UI strings were settled against the
wr_fleet_managementcheckout rather than inferred.Verification
All five pre-PR checks pass locally:
check:video,test:files,check:downloads,typecheck,build. The build is what proves the new anchors resolve —onBrokenLinksandonBrokenAnchorsare both set to throw.Served the build and read the sections in light and dark at 1280px and at 400px: no horizontal overflow (385px content in a 400px window).