bigcommerce / catalyst

Catalyst - for Composable Commerce
https://catalyst-demo.site
MIT License
93 stars 65 forks source link

docs: add catalyst-client documentation #1363

Open bc-andreadao opened 5 days ago

bc-andreadao commented 5 days ago

What/Why?

Document how to use the client for fetching data from BigCommerce Storefront API

Methods have their parameters, return values, etc. documented (e.g. how to use client.fetch(), etc)

Testing

N / A

changeset-bot[bot] commented 5 days ago

⚠️ No Changeset found

Latest commit: 1d42ad11b0088b40b4ce8090672944d3ac66168a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel[bot] commented 5 days ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
catalyst-latest ✅ Ready (Inspect) Visit Preview Sep 13, 2024 3:36am
5 Skipped Deployments | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **catalyst-1millionproducts-store** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-1millionproducts-store/DvyQdEkLEPbnWdhyDhUJNTUqWAJB)) | [Visit Preview](https://catalyst-1millionproducts-store-git-27d8c4-bigcommerce-platform.vercel.app) | | Sep 13, 2024 3:36am | | **catalyst-au** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-au/EVcEtJKdBwvTjwGPdBo73G3sx3ig)) | [Visit Preview](https://catalyst-au-git-catalyst-client-docs-bigcommerce-platform.vercel.app) | | Sep 13, 2024 3:36am | | **catalyst-test-store** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-test-store/CfTkjiPBLSqrLkm6zAn8mJjJKsQA)) | [Visit Preview](https://catalyst-test-store-git-catalyst-cl-1baaeb-bigcommerce-platform.vercel.app) | | Sep 13, 2024 3:36am | | **catalyst-uk** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-uk/FuDe8AirN8uohkJZo3rhjnpjTCqB)) | [Visit Preview](https://catalyst-uk-git-catalyst-client-docs-bigcommerce-platform.vercel.app) | | Sep 13, 2024 3:36am | | **catalyst-unstable** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-unstable/2ex3vN749ofSBHgvLiVgetJmsZZw)) | [Visit Preview](https://catalyst-unstable-git-catalyst-client-docs-bigcommerce-platform.vercel.app) | | Sep 13, 2024 3:36am |
github-actions[bot] commented 5 days ago

⚡️🏠 Lighthouse report

Lighthouse ran against https://catalyst-latest-7pmfs9c4z-bigcommerce-platform.vercel.app

🖥️ Desktop

We ran Lighthouse against the changes on a desktop and produced this report. Here's the summary:

Category Score
🟢 Performance 100
🟢 Accessibility 100
🟢 Best practices 96
🟠 SEO 82

📱 Mobile

We ran Lighthouse against the changes on a mobile and produced this report. Here's the summary:

Category Score
🟢 Performance 97
🟢 Accessibility 100
🟢 Best practices 96
🟠 SEO 85