docs: robot stack 9.1.0#21677
Open
ecormany wants to merge 8 commits into
Open
Conversation
ecormany
added
docs
DO NOT MERGE
ecormany
force-pushed
the
docs-release-9.1.0
branch
from
040d90a to
8356121
Compare
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## edge #21677 +/- ##
=======================================
Coverage 21.30% 21.30%
=======================================
Files 3912 3912
Lines 326847 326848 +1
Branches 58106 58104 -2
=======================================
+ Hits 69629 69633 +4
+ Misses 254228 254223 -5
- Partials 2990 2992 +2
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
ecormany
force-pushed
the
docs-release-9.1.0
branch
2 times, most recently
from
3f9bb4d to
13479dd
Compare
# Overview This explains how to downgrade OT-2 robot software. It attempts to explain how to - Downgrade from 26.06 to an earlier version - Downgrade from v9.0 to and earlier version We're not recommening running multiple versions of the App on the same machine. This gets complex, particularly with Windows. Easier on Linux and Mac, but maybe not a good practice. **Sandbox:** https://sandbox.docs.opentrons.com/downgrade-ot2-software-instructions/ot-2/opentrons-app/ot2-downgrade/ RTC-990 ## Test Plan and Hands on Testing - Check links. ## Changelog Adds a new doc, `ot2-downgrade.md` to the Opentrons App section of the OT-2 manual. ## Review requests - Does the procedure seem clear and accurate. ## Risk assessment - Low, because docs only. - Medium, because this can get complicated. --------- Co-authored-by: emilyburghardt <emily.burghardt@opentrons.com>
# 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))
Adding step grouping to the API docs for 2.29. Includes a screenshot showing why this is useful in protocol visualization! --------- Co-authored-by: Edward Cormany <edward.cormany@opentrons.com>
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](https://opentrons.atlassian.net/browse/RTC-1006)). - 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](https://opentrons.atlassian.net/browse/AUTH-2902?focusedCommentId=153251&sourceType=mention)
ecormany
force-pushed
the
docs-release-9.1.0
branch
from
9148817 to
91d7626
Compare
# Overview Change "Opentrons App" to "Opentrons OT-2 App" in the OT-2 manual. Swapped 1:1 except in any obvious cases where it might be obnoxious to repeat it. Might be more of those lingering. ## Test Plan and Hands on Testing ## Changelog ## Review requests ## Risk assessment low.
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
3 participants
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.
Overview
PR collecting all documentation that is timed with the RS 9.1.0 release (and the OT-2 26.6 release, and the very quickly following PD releases).
Test Plan and Hands on Testing
Sandbox
Changelog
Review requests
Risk assessment
low-med, lots of docs together.