Skip to content

docs: plate reader manual #19136

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 10 commits into
base: edge
Choose a base branch
from
Open

docs: plate reader manual #19136

wants to merge 10 commits into from

Conversation

jwwojak
Copy link
Contributor

@jwwojak jwwojak commented Aug 6, 2025

Overview

This PR migrates the plate reader instruction manual to MkDocs.

RTC-783

Test Plan and Hands on Testing

Check for grammar, style, and closely match the original source.

Changelog

Manual reog (minor)

Some sections of the original PDF were very short and looked weird as standalone pages. These have been moved into the "Product Specifications" section. Specifically, these:

  • Measurement specs
  • Detection wavelengths
  • Status light
  • Input/output (the power specs)

New CSS

Added to shared/instruction-manual.css. This creates a status dot that shows a 🌈 or color spectrum for one of the dots. The reader LED has a status that shows multiple colors.

/* Creates dot with red to blue spectrum lines. See plate reader LED table. */

.status-dot.rainbow {
  background-image: linear-gradient(to right, red, orange, yellow, green, blue);
  background-color: transparent; 
}

Code called in LED status light table:

<tr>
      <td><span class="status-dot-container"><span class="status-dot rainbow"></span>Various</span></td>
      <td>Solid</td>
      <td>Initialization/measurement in progress. The status light color corresponds to the selected light wavelength used for analysis.</td>
    </tr>

Which produces this:

tasteTheRainbow

Detection wavelengths text

This short section lists the wavelengths the module uses for detection. I added color codes to the text in parenthesis (red, green, blue, etc.) to match the wavelengths. Thought that might be a neat touch. Can remove. See specifications.md, section starts on line 97.

Review requests

Short manual. Shouldn't be much to review.

Risk assessment

Low, docs change only.

@jwwojak jwwojak requested a review from ecormany August 6, 2025 16:05
@jwwojak jwwojak self-assigned this Aug 6, 2025
@jwwojak jwwojak changed the title Plate reader manual docs: plate reader manual Aug 6, 2025
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