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

chore(shipping): SHIPPING-3046 Update V2 shipping docs with channels #554

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

payaalaee
Copy link
Contributor

@payaalaee payaalaee commented Sep 30, 2024

SHIPPING-3046

What changed?

  • Update V2 shipping document introducing channels

Release notes draft

As a part of MSF project and introducing channels, we want to update our docs to reflect the new feature.
channels filed is the list of channels associated with a method.

Anything else?

N/A

ping @bigcommerce/team-shipping @bc-andreadao

@payaalaee payaalaee marked this pull request as ready for review September 30, 2024 01:35
bc-andreadao
bc-andreadao previously approved these changes Sep 30, 2024
@bc-andreadao
Copy link
Collaborator

Thanks @payaalaee . I created PR 556 so we can talk about the use cases & limitations in the doc, if you could review/approve

reference/shipping.v2.yml Show resolved Hide resolved
reference/shipping.v2.yml Outdated Show resolved Hide resolved
reference/shipping.v2.yml Outdated Show resolved Hide resolved
reference/shipping.v2.yml Outdated Show resolved Hide resolved
reference/shipping.v2.yml Outdated Show resolved Hide resolved
reference/shipping.v2.yml Outdated Show resolved Hide resolved
reference/shipping.v2.yml Outdated Show resolved Hide resolved

| Property | Type | Description |
| - | - | - |
| channels | array | Channels associated with the method as an array of integers |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| channels | array | Channels associated with the method as an array of integers |
| channels | array | Channels associated with the method as an array of integers. |


| Property | Type | Description |
| - | - | - |
| channels | array | Channels associated with the method as an array of integers |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| channels | array | Channels associated with the method as an array of integers |
| channels | array | Channels associated with the method as an array of integers. |


| Property | Type | Description |
| - | - | - |
| channels | array | Channels associated with the method as an array of integers |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| channels | array | Channels associated with the method as an array of integers |
| channels | array | Channels associated with the method as an array of integers. |

Copy link
Collaborator

@bc-andreadao bc-andreadao left a comment

Choose a reason for hiding this comment

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

Looks good, left minor punctuation suggestions to keep the style consistent

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.

4 participants