Skip to content

docs: heater-shaker instruction manual #19103

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

Open
wants to merge 22 commits into
base: edge
Choose a base branch
from

Conversation

jwwojak
Copy link
Contributor

@jwwojak jwwojak commented Aug 1, 2025

Overview

This migrates the Heater-Shaker manual to MkDocs.

RTC-781

Test Plan and Hands on Testing

Review for the usual.

Changelog

Review requests

Image resize problem
Having a lot of trouble with resizing the image adapter-attachment.png in the adapters.md section. This is in an ordered list / procedure list and normally gets indented to match the list. However, when indented the image always renders as full size.

I tried to left justify the image, and then it resizes properly, but the then the warning admonition that follows it breaks and renders as a code block.

Temporary fix:

  • left justify the image and set a size
  • move the admonition above/before the image so it can be indented with the list text and still work.
  • not sure how to fix this. please take a look.
adapter attach issue

LED table alignment problem
In specifications.md the amber dot and text don't align. However, this should be fixed on merge because in a previous merge for another module, I added status-dot-container CSS to handle this.

alignment

Risk assessment

Low, docs only.

@jwwojak jwwojak requested a review from ecormany August 1, 2025 16:42
@jwwojak jwwojak self-assigned this Aug 1, 2025
Copy link

codecov bot commented Aug 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 24.24%. Comparing base (2650977) to head (4746532).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             edge   #19103   +/-   ##
=======================================
  Coverage   24.24%   24.24%           
=======================================
  Files        3370     3370           
  Lines      296429   296429           
  Branches    37694    37694           
=======================================
  Hits        71879    71879           
  Misses     224526   224526           
  Partials       24       24           
Flag Coverage Δ
protocol-designer 18.94% <ø> (ø)

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.

jwwojak added 3 commits August 4, 2025 09:25
Strange leading spaces in

- docs/shared/modules/index.md

and

- docs/mkdocs.yml
@jwwojak
Copy link
Contributor Author

jwwojak commented Aug 4, 2025

Adapter image re-sizing problem resolved w/ help from @ecormany (thank you). However, I still have to put the warning admonition before the image. When indenting it to match the ordered list, which you can do but not in this case, MkDocs renders it as a code block. Putting the admonition before the list solves the problem and allows you to indent the warning.

Also, the spacing in the LED table is resolved by CSS I added to docs/shared/instruction-manuals.css in a previous push (maybe for the Thermocycler). This:

 /* Aligns status dots and text if needed*/
.status-dot-container {
  display: flex;
  align-items: center;
  gap: 5px;
}

This is ready for review.

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.

1 participant