-
Notifications
You must be signed in to change notification settings - Fork 192
docs: touchscreen-settings-available-features #20424
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: edge
Are you sure you want to change the base?
Conversation
emilyburghardt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
general comments to open a discussion!
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## edge #20424 +/- ##
==========================================
- Coverage 56.76% 56.76% -0.01%
==========================================
Files 3911 3911
Lines 322702 322702
Branches 45747 45747
==========================================
- Hits 183186 183177 -9
- Misses 139299 139308 +9
Partials 217 217
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Put settings in alphabetical order.
So we don't need to update the image. Explain "yours can look different" and keep the definitions up to date. This is good enough.
Overview
Updates the Flex manual chapter Touchscreen > Robot Settings. This lists and describes the currently available features on that part of the touchscreen.
Sandbox: https://sandbox.docs.opentrons.com/docs-touchscreen-settings-revisions/flex/touchscreen/settings/
RTC-896
Maybe for January.
Test Plan and Hands on Testing
Check images and links.
Changelog
This PR introduces some changes to the existing doc to take advantage of MkDocs features (e.g. tables of contents) that weren't available when this was first created.
Revised intro paragraph
Changed image to fade out and show fewer options from the settings screen. Why? Gets us out of the business of maintaining an image when features change. Just update text and show only enough of an image so readers recognize/know where they are on the touchscreen. Text changes are easier than image updates.
Keeps the topical section organization but now uses H2 and H3 headers to show all the settings on the page-level TOC.
In the current version, the TOC is somewhat opaque with category headers only. With H3s we can now list and show all the settings, which also eliminates the need for a full image at the beginning.
Review requests
Still unsure about one particular setting: Disabling some Stacker x y axis detection. Checking on it. A WTF item.Risk assessment