-
Notifications
You must be signed in to change notification settings - Fork 186
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
base: edge
Are you sure you want to change the base?
Conversation
Because, reasons.
Tables and images
Need to add images.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Strange leading spaces in - docs/shared/modules/index.md and - docs/mkdocs.yml
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
This is ready for review. |
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 theadapters.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:
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 addedstatus-dot-container
CSS to handle this.Risk assessment
Low, docs only.