Skip to content
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

docs(app): add quick transfer doc to keep track of versioning #17473

Merged
merged 2 commits into from
Feb 10, 2025

Conversation

smb2268
Copy link
Contributor

@smb2268 smb2268 commented Feb 7, 2025

Overview

This PR adds a versioning doc to keep track of changes in Quick Transfer. We don't currently read designerApplicationData for QT but this will enable us to do so in the future and migrate old iterations if need be.

Review requests

Does this location make sense as the place to store this information?

Risk assessment

Docs only

@smb2268 smb2268 self-assigned this Feb 7, 2025
@smb2268 smb2268 requested a review from a team as a code owner February 7, 2025 21:40
Copy link
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.

amazing! thanks for writing this up. This is unrelated but it is confusing that we have a DesignerApplicationData for pd and one for quick transfer since they vary drastically 🤔 it is probably fine though since the types are defined in different projects

@smb2268
Copy link
Contributor Author

smb2268 commented Feb 7, 2025

amazing! thanks for writing this up. This is unrelated but it is confusing that we have a DesignerApplicationData for pd and one for quick transfer since they vary drastically 🤔 it is probably fine though since the types are defined in different projects

@jerader The idea was to have the field be the same since it should serve the same purpose - both are data specific to the application the protocol was designed with that can be reabsorbed by that application. The name field can be used to determine which application it's compatible with/which TS type it is. Doesn't PD have name: opentrons/protocol-designer?

@jerader
Copy link
Collaborator

jerader commented Feb 7, 2025

amazing! thanks for writing this up. This is unrelated but it is confusing that we have a DesignerApplicationData for pd and one for quick transfer since they vary drastically 🤔 it is probably fine though since the types are defined in different projects

@jerader The idea was to have the field be the same since it should serve the same purpose - both are data specific to the application the protocol was designed with that can be reabsorbed by that application. The name field can be used to determine which application it's compatible with/which TS type it is. Doesn't PD have name: opentrons/protocol-designer?

@smb2268 , oh ya it does! okay that makes sense to me 😄

@smb2268 smb2268 merged commit 5da85c3 into edge Feb 10, 2025
30 checks passed
@smb2268 smb2268 deleted the app_quick-transfer-doc branch February 10, 2025 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants