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(documentation): update javascript sdk docs #58

Merged
merged 3 commits into from
May 10, 2023
Merged

docs(documentation): update javascript sdk docs #58

merged 3 commits into from
May 10, 2023

Conversation

rvanlaarhoven
Copy link
Contributor

I noticed the JavaScript SDK docs are out of date and don't represent the current state of the SDK's API.

Note that I also removed the COUNTRIES section since those are not exposed in the @myparcel/constants package, which might be a bug.

It also does not yet reflect the need to install @myparcel/constants if you want to use any constants. Not sure if you want me to add that to the initial installation instructions or add it separately to the "Using constants" section?

@rvanlaarhoven rvanlaarhoven requested review from a team as code owners May 8, 2023 16:17
@netlify
Copy link

netlify bot commented May 8, 2023

Deploy Preview for myparcel-developer-portal ready!

Name Link
🔨 Latest commit 041ce6a
🔍 Latest deploy log https://app.netlify.com/sites/myparcel-developer-portal/deploys/645b7c30c2f5170007d39f96
😎 Deploy Preview https://deploy-preview-58--myparcel-developer-portal.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Contributor

@EdieLemoine EdieLemoine left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution! You're right, this should have been updated. I've added some comments, if those are resolved we'll merge this. 😄

src/documentation/51.javascript-sdk.md Outdated Show resolved Hide resolved
src/documentation/51.javascript-sdk.md Show resolved Hide resolved
@EdieLemoine EdieLemoine enabled auto-merge May 10, 2023 11:12
@EdieLemoine EdieLemoine changed the title docs: Align JavaScript SDK docs with current api state docs(documentation): update javascript sdk docs May 10, 2023
@EdieLemoine EdieLemoine added this pull request to the merge queue May 10, 2023
Merged via the queue into myparcelnl:main with commit 66bcc3a May 10, 2023
@rvanlaarhoven rvanlaarhoven deleted the patch-1 branch May 10, 2023 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants