Skip to content

docs(protocol-designer): PD 8.10 manual revisions#21177

Open
emilyburghardt wants to merge 9 commits intochore_release-pd-8.10.0from
docs-pd-8.10
Open

docs(protocol-designer): PD 8.10 manual revisions#21177
emilyburghardt wants to merge 9 commits intochore_release-pd-8.10.0from
docs-pd-8.10

Conversation

@emilyburghardt
Copy link
Copy Markdown
Collaborator

@emilyburghardt emilyburghardt commented Apr 2, 2026

Overview

Test Plan and Hands on Testing

sandbox

Changelog

  • reworking transfer.md a bit (it's getting pretty long) to add more sections that better separate the choices users have to make, and reflect the order of those choices in PD.
  • adding more description of partial tip pickup (and related collision errors).
  • added small description change to indicate that you can now choose the blowout "start point" if your blowout location is a source or destination well.
  • adds an updated stacker step screenshot on the Modules page.
  • adds a tip for reimporting, updating, and exporting an updated version of a PD protocol to take advantage of protocol viz.

Review requests

Need to decide on nozzle naming to use in the PD manual. Either A) match PAPI nozzle naming exactly or B) differentiate slightly, because PD never shows the values we'll refer to

is everything else clear?

Risk assessment

low.

Copy link
Copy Markdown
Contributor

@jwwojak jwwojak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly some broad comments vs specific line edits.

I'm confused by referring to UI sections as "forms." It might be difficult for a reader to keep a count in their head (I'm on form 1 or form 2, maybe it's form 3). Instead, try to associate a process with a descriptive label, particularly if the UI has a label for different sections.

Comment thread docs/protocol-designer/docs/steps/transfer.md
Comment thread docs/protocol-designer/docs/steps/transfer.md
Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Comment thread docs/protocol-designer/docs/warnings-errors.md
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 55.31%. Comparing base (d39b753) to head (6da7aa7).

Additional details and impacted files

Impacted file tree graph

@@                     Coverage Diff                     @@
##           chore_release-pd-8.10.0   #21177      +/-   ##
===========================================================
- Coverage                    55.32%   55.31%   -0.01%     
===========================================================
  Files                         4004     4004              
  Lines                       339099   339099              
  Branches                     51858    51878      +20     
===========================================================
- Hits                        187602   187576      -26     
- Misses                      151279   151305      +26     
  Partials                       218      218              
Flag Coverage Δ
app 45.20% <ø> (+0.03%) ⬆️
step-generation 5.72% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 4 files with indirect coverage changes

🚀 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.

@emilyburghardt emilyburghardt marked this pull request as ready for review April 9, 2026 21:38
Copy link
Copy Markdown
Collaborator

@jerader jerader left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!!

Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Copy link
Copy Markdown
Contributor

@rclarke0 rclarke0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree with Joe's comments as well!

@emilyburghardt emilyburghardt changed the title docs(protocol-designer): expanded partial tip in PD 8.10 docs(protocol-designer): PD 8.10 manual revisions Apr 14, 2026
Copy link
Copy Markdown
Contributor

@jwwojak jwwojak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@ecormany ecormany added the docs label Apr 17, 2026
Copy link
Copy Markdown
Contributor

@ecormany ecormany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few copy suggestions, including a handful of typos that should definitely get fixed. In general, the additions are great!

Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Comment thread docs/protocol-designer/docs/steps/transfer.md Outdated
Comment thread docs/protocol-designer/docs/modify-protocol.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants