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: Improves getting started section and fixes typos #317

Merged
merged 1 commit into from Apr 16, 2023

Conversation

lmac-1
Copy link
Contributor

@lmac-1 lmac-1 commented Mar 20, 2023

Hey Nick! Here's a collection of small updates to improve the getting started sections of the docs and also fix a few broken links/typos:

  • Fixes broken link in CartProvider
  • Removes references to "look at the API below" as the structure of the docs has changed since this was written
  • Adds extra context on client only mode about adding products on the Stripe dashboard
  • Adds link to Typescript example in GitHub
  • Adds comments about price being in smallest currency unit in code examples (this confused me a bit when I was configuring it for the first time)
  • Makes all note formatting consistent ("Note")

These are basically some things I noticed or wanted to add after going through the documentation myself for the first time to make it a bit clearer.

Side note: I'm wondering if we should have a section in the documentation linking to the different examples that we have in the code for TypeScript, Next.js etc?

@netlify
Copy link

netlify bot commented Mar 20, 2023

👷 Deploy request for useshoppingcart pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit dcca3f2

@lmac-1 lmac-1 changed the title Improves getting started section and fixes typos Docs: Improves getting started section and fixes typos Mar 20, 2023
Copy link
Owner

@dayhaysoos dayhaysoos left a comment

Choose a reason for hiding this comment

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

Thanks @lmac-1, these changes are great!

I'd definitely love an example section. I actually started working on examples, replacing the CRA app with Vite is one thing I'm working on right now.

Do you think the examples should live on separate repos or point to the examples within the USC repo?

@dayhaysoos dayhaysoos merged commit 92b7371 into dayhaysoos:master Apr 16, 2023
1 of 6 checks passed
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.

None yet

2 participants