docs(stacker): Stacker instruction manual PR #18664

jwwojak · 2025-06-17T20:55:43Z

Committing Stacker instruction manual files.

Overview

This is the Stacker instruction manual.

Test Plan and Hands on Testing

Will review the text for the usual style, grammar, and the usual writing stuff. Also, check to make sure links work and images appear as expected. This doesn't have some of the recent CSS, but posting it up anyway to get started.

Changelog

No changes. This is new content.

Review requests

Nothing specific. Please review and comment.

Risk assessment

Low to medium as this is a new docs feature. Who knows what horrors may lurk within.

Committing Stacker instruction manual files.

codecov · 2025-06-18T17:47:16Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.91%. Comparing base (4b97d22) to head (7356731).
Report is 2 commits behind head on edge.

Additional details and impacted files

@@           Coverage Diff           @@
##             edge   #18664   +/-   ##
=======================================
  Coverage   56.91%   56.91%           
=======================================
  Files        3243     3243           
  Lines      282323   282323           
  Branches    35451    35451           
=======================================
  Hits       160680   160680           
  Misses     121440   121440           
  Partials      203      203

Flag	Coverage Δ
protocol-designer	`19.09% <ø> (ø)`

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.

ecormany

Looks good! Lots of code style comments. Happy to talk through them and make decisions on standardizing things across docs sites.

ecormany · 2025-06-23T14:30:48Z

docs/stacker-manual/docs/index.md

We should come up with a standard format for cover pages. Probably one of:

Same as print covers. Just logo, title, hero, company name, date.

Print cover info + Product Description. This is probably good for SEO or RAG or whatever.

Either way, I would move Manufacturer Description to the Additional Product Information page. Some print pubs have that ordering anyway.

Sure, will move the mfg description to the back, to the Additional Info page.

Here's my thinking about the home/landing page: I put the product description on this page because without it, the page doesn't have much information value. It's just an image and date of publication. The product summary seems nice here as it adds a small amount of information to what would otherwise be just a page with a picture. A little different than the manuals, but as a landing page, now it shows you the thing and provides a short description.

ecormany · 2025-06-23T14:31:07Z

docs/stacker-manual/docs/index.md

+  <img src="/images/tm-opentrons-flex.png" alt="flex-tm" style="width:70%">
+</a>
+
+# **Stacker Module GEN1 Instruction Manual**


H1 should never need or have bold styling.

Removed bold, but the text looks too skinny to me.

We'll make sure we have the right weight across the board in our theme CSS file.

ecormany · 2025-06-23T14:31:44Z

docs/stacker-manual/docs/index.md

+<b>[Opentrons Labworks Inc](https://opentrons.com/)</b><br>
+August 2025
+///
+</figure markdown>


Closing HTML tags don't have attributes. (This would be an error if you were doing HTML validation.)

My code here is super-wonky. Going to fix it.

ecormany · 2025-06-23T14:32:19Z

docs/stacker-manual/docs/index.md

+
+## Product Description
+
+The Opentrons Flex&trade; Stacker is an external module that provides automated, high-capacity storage for ANSI/SLAS compatible labware such as well plates, tip racks, and reservoirs. It also includes a shuttle, which moves labware from the Stacker to the deck where it can be accessed manually or by the Flex Gripper. While ideal for high-throughput NGS workflows, the Stacker can help streamline a wide range of automated liquid handling protocols. When attached, the Stacker increases your robot’s labware storage capacity and throughput, allowing you to run longer, more complex protocols without interruption. Each Flex supports up to four attached Stackers.


Let's use unicode everywhere. It makes the source more readable. So ™ here.

Unicode...Unicode everywhere.

ecormany · 2025-06-23T14:35:00Z

docs/stacker-manual/docs/stacker-compliance.md

I would recommend not repeating "stacker" in file names. The ultimate URL for this page would be something like docs.opentrons.com/stacker-manual/stacker-compliance. This is one reason I think just stacker would be better for the parent directory as well: docs.opentrons.com/stacker/compliance is very clean and includes all the same information.

Shortening the file names. Dropping stacker-.

ecormany · 2025-06-23T15:41:51Z

docs/stacker-manual/docs/stylesheets/extra.css

+.center-image {
+    display: block; /* Make the image a block-level element */
+    margin-left: auto; /* Push it to the center horizontally */
+    margin-right: auto; /* Push it to the center horizontally */
+}
+
+/* New class for end-of-doc trademark text */
+.trademark-text {
+    font-size: 0.85em;  /* set size */
+    color: #555;       /* set color */
+    display: block;     /* text acts like a paragraph */
+    margin-top: 2em;   /* spacing at top */
+}


These look like ""helpful"" LLM comments 🤖 They're noisy and we should remove them.

ecormany · 2025-06-23T15:42:34Z

docs/stacker-manual/mkdocs.yml

+  - md_in_html
+  - toc:
+      permalink: true
+      title: <u>Page Contents</u>


Let's remove the underline here and rely on theme CSS (if we decide to underline it at all; it looks like a link, but it's not)

ecormany · 2025-06-23T15:43:00Z

docs/stacker-manual/mkdocs.yml

+copyright:
+  Copyright &copy; OPENTRONS, 2025. ALL RIGHTS RESERVED
+
+nav:


I've tended to put nav near the top of the YAML file, but it clearly doesn't matter.

ecormany · 2025-06-23T15:43:33Z

docs/stacker-manual/docs/.gitignore

Can remove this, should be covered by the main docs/.gitignore.

ecormany · 2025-06-23T15:43:56Z

docs/stacker-manual/docs/stacker-preinstall.md

+
+![power-data-cables](images/power-and-data.png)
+
+The The following table lists and describes the function of each cable.


👯

Suggested change

The The following table lists and describes the function of each cable.

The following table lists and describes the function of each cable.

ecormany · 2025-06-25T02:15:59Z

docs/stacker-manual/docs/index.md

@@ -0,0 +1,30 @@
+<a href="https://opentrons.com/">
+  <img src="/images/tm-opentrons-flex.png" alt="flex-tm" style="width:70%">


Didn't spot this on my first pass through, but these URLs should not have leading slashes. That makes them absolute URLs, which will break in just about any deployment scenario. For example, if this image is meant to be at docs.opentrons.com/stacker-manual/images/tm-opentrons-flex.jpg this would instead point to docs.opentrons.com/images/tm-opentrons-flex.png, which wouldn't exist. Start with ../

That's what I did in a first draft, used ../ However, that didn't work, didn't render the image in a local build while just / did work. But now ../ works so, reasons I guess?

…entrons into docs-stacker-manual

Mostly markdown, CSS, and HTML refactoring.

jwwojak

Making changes in a new push.

jwwojak · 2025-06-26T19:10:15Z

docs/stacker-manual/docs/stacker-compliance.md

Shortening the file names. Dropping stacker-.

jwwojak · 2025-06-26T19:17:55Z

docs/stacker-manual/docs/stacker-compliance.md

+!!!warning
+    Changes or modifications to this module not expressly approved by Opentrons could void the user’s authority to operate the equipment. This device complies with part 15 of the FCC Rules.
+
+!!!note
+    This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15 of the FCC rules. These limits are designed to provide a reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at their own expense.


Removed call-out text. Instead, the FCC warning and note will be H4s under the FCC H3.

They won't appear in the page-level TOC as toc-depth: 3, but the FCC section will.

jwwojak · 2025-06-26T19:20:56Z

docs/stacker-manual/docs/stacker-compliance.md

+
+Le présent produit est conforme aux spécifications techniques applicables d’Innovation, Sciences et Développement économique Canada.
+
+CISPR 11 Class A


jwwojak · 2025-06-26T19:21:28Z

docs/stacker-manual/docs/stacker-compliance.md

+
+CISPR 11 Class A
+
+!!!caution


Removed admonition in favor of Caution as part of the text.

jwwojak · 2025-06-26T19:28:01Z

docs/stacker-manual/docs/stacker-compliance.md

+
+#### WEEE Policy
+
+Opentrons is dedicated to adhering to the EU Directive on Waste Electrical and Electronic Equipment (WEEE – 2012/19/EU). Our goal is to ensure that our products are properly disposed of or recycled once they reach the end of their useful life. 


Fixing to use em, but keeping vertical-align so icon stays centered with line of text.

jwwojak · 2025-06-26T19:46:25Z

docs/stacker-manual/docs/stacker-preinstall.md

+
+After your Stacker is attached to the deck and powered on, instructions and animated images on the touchscreen take you through a guided setup.
+
+<img src="/images/touchscreen-map.png" alt="deck map" class="center-image" style="width:80%;">


Removing style="width:80%;"

No CSS in this one. The border is part of the image. For next time, CSS FTW.

jwwojak · 2025-06-26T19:48:28Z

docs/stacker-manual/docs/stacker-preinstall.md

+
+<img src="/images/touchscreen-map.png" alt="deck map" class="center-image" style="width:80%;">
+
+Because you can install a Stacker anywhere in column 4, and connect it to any port on the power/data hub, the touchscreen setup process gives you the opportunity to tell Flex where this module is on the deck. See [Post-Installation Procedures](stacker-postinstall.md#).


The # is valid, but redundant. Will remove.

jwwojak · 2025-06-26T19:53:12Z

docs/stacker-manual/docs/stacker-product-specifications.md

+![labeled-parts](images/parts-map4.png)
+
+## Stacker Box Parts
+
+The Stacker is packaged separately from the User Kit and ships with its own set of parts. The Stacker box contains the following items:
+
+![stacker-box](images/stacker-box3.svg)


Will completely redo this set of image. The numbers refer to different versions of trying to get the images to look right. As separate images and using CSS, these should look better.

jwwojak · 2025-06-26T19:57:10Z

docs/stacker-manual/docs/stacker-product-specifications.md

+        <th>Stacker status</th>
+    </tr>
+    <tr>
+        <td><span class="my-dot white"></span> White</td>


Let's try status-dot ?

jwwojak · 2025-06-26T20:14:58Z

docs/stacker-manual/docs/stacker-warranty.md

+<figure class="general" style="margin-top: 150px;">
+  <img src="/images/tm-opentrons-full-blackcolor.svg" alt="opentrons-logo" style="width: 60%;">
+  <figcaption>
+    <p><b>Post-sales & contacting Opentrons</b></p>
+    <p>If you have any questions about the use of the system,<br>
+    abnormal phenomena, or special needs, please contact:<br>
+    <a href="mailto:[email protected]">[email protected]</a>. Also visit <a href="https://www.opentrons.com">www.opentrons.com.</a></p>
+  </figcaption>
+</figure>


Less wonky with a CSS fix. Will commit shortly.

Committing Stacker instruction manual files.

Mostly markdown, CSS, and HTML refactoring.

…entrons into docs-stacker-manual

jwwojak

Made changes and pushed revisions.

Stacker manual first commit

b831393

Committing Stacker instruction manual files.

jwwojak requested review from ecormany and emilyburghardt June 17, 2025 20:55

jwwojak added docs mkdocs labels Jun 17, 2025

Stacker manual first commit

b38beb8

Committing Stacker instruction manual files.

ecormany force-pushed the docs-stacker-manual branch from b831393 to b38beb8 Compare June 18, 2025 17:41

ecormany reviewed Jun 23, 2025

View reviewed changes

ecormany reviewed Jun 25, 2025

View reviewed changes

jwwojak added 2 commits June 26, 2025 09:27

Merge branch 'docs-stacker-manual' of https://github.com/Opentrons/op…

50de9d7

…entrons into docs-stacker-manual

Changes from first review

309432a

Mostly markdown, CSS, and HTML refactoring.

jwwojak commented Jun 26, 2025

View reviewed changes

jwwojak added 2 commits June 26, 2025 16:39

Stacker manual first commit

a2d8097

Committing Stacker instruction manual files.

Changes from first review

7356731

Mostly markdown, CSS, and HTML refactoring.

jwwojak force-pushed the docs-stacker-manual branch from 309432a to 7356731 Compare June 26, 2025 20:39

Merge branch 'docs-stacker-manual' of https://github.com/Opentrons/op…

7f2b65a

…entrons into docs-stacker-manual

jwwojak commented Jun 26, 2025

View reviewed changes


		## Product Description

		The Opentrons Flex™ Stacker is an external module that provides automated, high-capacity storage for ANSI/SLAS compatible labware such as well plates, tip racks, and reservoirs. It also includes a shuttle, which moves labware from the Stacker to the deck where it can be accessed manually or by the Flex Gripper. While ideal for high-throughput NGS workflows, the Stacker can help streamline a wide range of automated liquid handling protocols. When attached, the Stacker increases your robot’s labware storage capacity and throughput, allowing you to run longer, more complex protocols without interruption. Each Flex supports up to four attached Stackers.


		![power-data-cables](images/power-and-data.png)

		The The following table lists and describes the function of each cable.

	The The following table lists and describes the function of each cable.
	The following table lists and describes the function of each cable.

		@@ -0,0 +1,30 @@
		<a href="https://opentrons.com/">
		<img src="/images/tm-opentrons-flex.png" alt="flex-tm" style="width:70%">


		Le présent produit est conforme aux spécifications techniques applicables d’Innovation, Sciences et Développement économique Canada.

		CISPR 11 Class A


		#### WEEE Policy

		Opentrons is dedicated to adhering to the EU Directive on Waste Electrical and Electronic Equipment (WEEE – 2012/19/EU). Our goal is to ensure that our products are properly disposed of or recycled once they reach the end of their useful life.


		After your Stacker is attached to the deck and powered on, instructions and animated images on the touchscreen take you through a guided setup.

		<img src="/images/touchscreen-map.png" alt="deck map" class="center-image" style="width:80%;">


		<img src="/images/touchscreen-map.png" alt="deck map" class="center-image" style="width:80%;">

		Because you can install a Stacker anywhere in column 4, and connect it to any port on the power/data hub, the touchscreen setup process gives you the opportunity to tell Flex where this module is on the deck. See [Post-Installation Procedures](stacker-postinstall.md#).

docs(stacker): Stacker instruction manual PR #18664

Are you sure you want to change the base?

docs(stacker): Stacker instruction manual PR #18664

Uh oh!

Conversation

jwwojak commented Jun 17, 2025

Overview

Test Plan and Hands on Testing

Changelog

Review requests

Risk assessment

Uh oh!

codecov bot commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ecormany left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jwwojak Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ecormany Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jwwojak left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jun 18, 2025 •

edited

Loading

jwwojak Jun 26, 2025 •

edited

Loading

ecormany Jun 25, 2025 •

edited

Loading