-
Notifications
You must be signed in to change notification settings - Fork 186
refactor(docs): split Flex Instruction Manual into more pages #19151
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
base: edge
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing all the specific labware stuff is a real improvement as is the new organization.
I only have comments about multiple instances of linked "Labware Library" references on the same page when we might be able to get away with doing that once, on first mention only.
Here's where it shows up as linked text multiple times:
index.md
: 2concepts.md
: 2types.md
: 3
Not many instances, but when combined with other links, a page can look cluttered.
Ready for review. Doing a self-review (i.e., proofread and checking links) throughout the day today. |
http://sandbox.docs.s3-website.us-east-2.amazonaws.com/docs-flex-manual-refactorLet us make sure the build and publish looks good. ![]() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Took a stroll through the sandbox and left a few comments- some nitpicks, mostly small things that aren't building right. can be picked up easily after this is merged, too.
|
||
When you install a pipette, you will be guided through the following steps on the touchscreen or in the Opentrons App. | ||
|
||
1. Choose pipette type |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
super nitpick that can be ticketed for later, but in the current manual these headers (choose pipette type/ prepare for installation etc.) really pop with the different text/color. Here, they look like plain text, so we could add some different style element like we had before.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this is directly following our web typography standards. I think we should feel free to modify if things are too same-y, to the point of making the text harder to read.
addressing these in #19163, thanks for spotting tho! |
Overview
The chapters of the Flex manual were great for a PDF book. They are toooooo long for web-based docs. This fixes that.
Test Plan and Hands on Testing
Sandbox.
Examining warnings from
mkdocs build
but not overly fussed about them now.Changelog
flex-manual
->flex
for better URLs.Review requests
Risk assessment
low-med. docs only but could've broken some internal links or something.