Skip to content

Conversation

@jwwojak
Copy link
Contributor

@jwwojak jwwojak commented Dec 18, 2025

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.

    • H2 headers are categories
    • H3 headers are individual settings

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.
  • Does the new organization/structure work. I think it does but is there an even better way to move things around?

Risk assessment

  • Low, docs only.

@jwwojak jwwojak requested a review from ecormany December 18, 2025 19:46
@jwwojak jwwojak self-assigned this Dec 18, 2025
@jwwojak
Copy link
Contributor Author

jwwojak commented Jan 8, 2026

And also, @vegano1 See settings.md , line 70. Stacker sensor feature description.

@jwwojak jwwojak marked this pull request as ready for review January 8, 2026 18:31
@jwwojak jwwojak requested a review from emilyburghardt January 9, 2026 15:12
Copy link
Collaborator

@emilyburghardt emilyburghardt left a 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
Copy link

codecov bot commented Jan 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.76%. Comparing base (c4b3936) to head (12ea191).
⚠️ Report is 1 commits behind head on edge.

Additional details and impacted files

Impacted file tree graph

@@            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              
Flag Coverage Δ
app 46.06% <ø> (-0.01%) ⬇️
step-generation 5.72% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 2 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants