Skip to content

additional 2.29 docs changes#21489

Draft
emilyburghardt wants to merge 5 commits into
docs-release-9.1.0from
docs-additional-api-2.29
Draft

additional 2.29 docs changes#21489
emilyburghardt wants to merge 5 commits into
docs-release-9.1.0from
docs-additional-api-2.29

Conversation

@emilyburghardt
Copy link
Copy Markdown
Collaborator

@emilyburghardt emilyburghardt commented May 12, 2026

Overview

Additional updates to docs for API 2.29. Depends on PR #21556 (should be merged first), and includes:

  • breaking Liquid Classes into multiple articles collapsed into a single section (we have a LOT of information here. there are a few links that will need to be changed in the Flex manual and, this change is ticketed here).
  • unhiding set_empty() docs I wrote earlier (API 2.28) now that we have a fix (previously, tip racks that were set as empty did not appear as empty in deck setup and could have presented a collision risk).
  • versioning page (trying out some new language for the OT-2 app)
  • fix incorrect use of set_for_volume in liquid class custom code example that Sanniti found

Test Plan and Hands on Testing

sandbox (once it builds)

Changelog

Review requests

I've checked all the links in the updated liquid class articles, but a second set of eyes can't hurt.

Risk assessment

low.

@@ -60,14 +60,15 @@ If you upload a protocol that specifies a higher API level than the maximum supp
Opentrons robots running the latest software ({{ robot_stack_version }}) support the following version ranges:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence needs an update because it talks about a single app.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in some language earlier to specify that there's different apps and software versions. See what you think.

The way it was earlier felt to me a bit like the software split was being hidden from users. I don't need to hammer this home here, but I feel like it should get a mention.

@emilyburghardt emilyburghardt force-pushed the docs-additional-api-2.29 branch from 2465131 to b929a03 Compare May 20, 2026 20:38
@emilyburghardt emilyburghardt changed the base branch from docs-release-9.1.0 to chore_release-9.1.0 May 20, 2026 20:38
@codecov
Copy link
Copy Markdown

codecov Bot commented May 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 21.70%. Comparing base (baaf7a7) to head (b929a03).
⚠️ Report is 16 commits behind head on chore_release-9.1.0.

Additional details and impacted files

Impacted file tree graph

@@                 Coverage Diff                  @@
##           chore_release-9.1.0   #21489   +/-   ##
====================================================
  Coverage                21.70%   21.70%           
====================================================
  Files                     3911     3911           
  Lines                   327234   327234           
  Branches                 58192    58195    +3     
====================================================
  Hits                     71041    71041           
  Misses                  253222   253222           
  Partials                  2971     2971           
Flag Coverage Δ
app 46.02% <ø> (ø)
protocol-designer 39.79% <ø> (ø)
step-generation 61.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 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.

@emilyburghardt emilyburghardt requested a review from ecormany June 3, 2026 16:39
@emilyburghardt emilyburghardt added the DO NOT MERGE Indicates a PR should not be merged, even if there's a shiny green merge button available label Jun 3, 2026
@emilyburghardt emilyburghardt force-pushed the docs-additional-api-2.29 branch 2 times, most recently from b55fe80 to 986757d Compare June 3, 2026 21:38
@emilyburghardt emilyburghardt requested a review from sanni-t June 4, 2026 15:10
emilyburghardt added a commit that referenced this pull request Jun 4, 2026
# Overview

This PR adds: 

- a description of step groups (and a screenshot) to protocol viz in the
Flex manual _(note that this docs build will continue to fail due to
links to `groups.md` in the API docs, which exists only in
`chore_release-9.1.0`)_
- updated links to the liquid classes section of the API docs, to be
added in #21489 _(again, this docs build will fail because this branch
doesn't know those links have been updated)_
- updates to PAPI-exclusive features in the Flex manual: mainly, that
partial tip pickup is no longer exclusive to PAPI. I removed this from
PAPI-exclusive features and instead added a brief description to
`protocols/designer.md`


This PR targets `docs-release-9.1.0`, so it could be merged in while
failing if we feel that the syntax here is correct!

## Test Plan and Hands on Testing


[sandbox](https://sandbox.docs.opentrons.com/docs-flex-step-groups-and-more/)

## Changelog

See above.

## Review requests

Is the syntax correct (so this can be merged into our isolated docs
release branch even if the build fails)?

## Risk assessment

should get a close look at the liquid classes links. I updated the
structure simply to clean up the left hand side in the API docs in PR
#21489 ; summary below as well:

the new folder `python-api/docs/liquid-classes`, which contains: 
-  a folder `lc_icons` for the images for the properties table
- new file `customize.md` (same text as [Customizing Liquid
Classes](https://docs.opentrons.com/python-api/liquid-classes/#customizing-liquid-classes))
- new file `definitions.md` (same text/tables as [Liquid Class
Definitions](https://docs.opentrons.com/python-api/liquid-class-definitions/)
- new file `index.md`
- new file `liquid-classes.md` (like in the current liquid classes
[page](https://docs.opentrons.com/python-api/liquid-classes/#opentrons-verified-liquid-classes))
- new file `using-liquid-classes.md` (same text as [Using Liquid
Classes](https://docs.opentrons.com/python-api/liquid-classes/#using-liquid-classes))
@ecormany ecormany force-pushed the docs-additional-api-2.29 branch from 986757d to 690cafd Compare June 5, 2026 15:50
@ecormany ecormany changed the base branch from chore_release-9.1.0 to docs-release-9.1.0 June 5, 2026 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DO NOT MERGE Indicates a PR should not be merged, even if there's a shiny green merge button available docs mkdocs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants