Skip to content

Commit 56c186b

Browse files
docs: adding PD manual (mkdocs) (#18833)
<!-- Thanks for taking the time to open a Pull Request (PR)! Please make sure you've read the "Opening Pull Requests" section of our Contributing Guide: https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-pull-requests GitHub provides robust markdown to format your PR. Links, diagrams, pictures, and videos along with text formatting make it possible to create a rich and informative PR. For more information on GitHub markdown, see: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax To ensure your code is reviewed quickly and thoroughly, please fill out the sections below to the best of your ability! --> # Overview Adding files for an updated PD manual, built with mkdocs. This PR is a mix of 1) getting the text and images into mkdocs and 2) changes to the manual for REV2 and to better fit the mkdocs format. <!-- Describe your PR at a high level. State acceptance criteria and how this PR fits into other work. Link issues, PRs, and other relevant resources. --> ## Test Plan and Hands on Testing <!-- Describe your testing of the PR. Emphasize testing not reflected in the code. Attach protocols, logs, screenshots and any other assets that support your testing. --> ## Changelog <!-- List changes introduced by this PR considering future developers and the end user. Give careful thought and clear documentation to breaking changes. --> adds new markdown files and images to a docs folder. changes to the PD manual include new text for PD 8.5.0 (liquid classes, PD > Python, other small changes), and additional images, headers, etc. plus some text tweaking to better fit the mkdocs format. TODO: - remove lightbox from yml? or enable only on specific pages? ## Review requests <!-- - What do you need from reviewers to feel confident this PR is ready to merge? - Ask questions. --> ## Risk assessment <!-- - Indicate the level of attention this PR needs. - Provide context to guide reviewers. - Discuss trade-offs, coupling, and side effects. - Look for the possibility, even if you think it's small, that your change may affect some other part of the system. - For instance, changing return tip behavior may also change the behavior of labware calibration. - How do your unit tests and on hands on testing mitigate this PR's risks and the risk of future regressions? - Especially in high risk PRs, explain how you know your testing is enough. --> --------- Co-authored-by: Edward Cormany <[email protected]>
1 parent e7e9c39 commit 56c186b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+727
-0
lines changed

docs/pd-manual/docs/about-pd.md

Lines changed: 31 additions & 0 deletions

docs/pd-manual/docs/editing-steps.md

Lines changed: 45 additions & 0 deletions
Lines changed: 17 additions & 0 deletions
Lines changed: 13 additions & 0 deletions

docs/pd-manual/docs/images/X.png

634 Bytes
139 KB
130 KB
207 KB
126 KB

docs/pd-manual/docs/images/check.png

714 Bytes

0 commit comments

Comments
 (0)