search

bigcommerce / catalyst

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

docs: add localization overview & guide #1332

Closed bc-andreadao closed 2 months ago

bc-andreadao commented 2 months ago

What/Why?

This PR adds the localization overview & guide back into the docs for DEVDOCS-6062.

PR 1298, where I originally added the localization overview & guide, was reverted in PR 1306. The reason was that subdirectories aren't supported for the catalyst.dev repository (https://bigcommerce.slack.com/archives/C0740QWEF9R/p1724446019589669), so the docs would not appear in the navigation bar.

This PR adds the overview & guide back into the docs, but places them under the /docs directory (no subdirectories).

See PR 21 for new navigation bar changes. Must merge this PR before PR 21.

Testing

N / A

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: 36253bc15d512a645a308c6a06ba16036dec2406

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 2 months 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 💬 Add feedback Sep 6, 2024 7:39pm
7 Skipped Deployments | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **catalyst** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst/7krbjF5NkHXFGpUEDMVanAx5npuf)) | | | Sep 6, 2024 7:39pm | | **catalyst-1millionproducts-store** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-1millionproducts-store/DjBVdWtmCTxumWYXDRmZQw21n3JP)) | [Visit Preview](https://catalyst-1millionproducts-store-git-c624c8-bigcommerce-platform.vercel.app) | | Sep 6, 2024 7:39pm | | **catalyst-au** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-au/6eXESBbkXxWRx5jNEX6pR3YJ4amW)) | [Visit Preview](https://catalyst-au-git-devdocs-6062-direct-f8ae10-bigcommerce-platform.vercel.app) | | Sep 6, 2024 7:39pm | | **catalyst-staging** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-staging/7y4qXNB9mfEvAV6ipsmseii4njbj)) | [Visit Preview](https://catalyst-staging-git-devdocs-6062-d-502e23-bigcommerce-platform.vercel.app) | | Sep 6, 2024 7:39pm | | **catalyst-test-store** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-test-store/3vHd2Eq4o6uBK36TUxK1yxtpLZGt)) | [Visit Preview](https://catalyst-test-store-git-devdocs-606-65def4-bigcommerce-platform.vercel.app) | | Sep 6, 2024 7:39pm | | **catalyst-uk** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-uk/7oyFzVv6G5G5DjPn5k6QXd97y4LM)) | [Visit Preview](https://catalyst-uk-git-devdocs-6062-direct-c3fb81-bigcommerce-platform.vercel.app) | | Sep 6, 2024 7:39pm | | **catalyst-unstable** | ⬜️ Ignored ([Inspect](https://vercel.com/bigcommerce-platform/catalyst-unstable/5nbdhSfpn13JzqpT5pLhSM7Ruknk)) | [Visit Preview](https://catalyst-unstable-git-devdocs-6062-864c5f-bigcommerce-platform.vercel.app) | | Sep 6, 2024 7:39pm |
jorgemoya commented 2 months ago

With #1333 we need to update the folder location of some of the objects we set for localization.

bc-andreadao commented 2 months ago

@jorgemoya It looks like PR 1333 is merged. Can my PR be approved?

jorgemoya commented 2 months ago

I think I confused things @bc-andreadao. What I meant to say is that with the latest changes from #1333, the i18n.ts file no longer exists, instead we define languages in routing.ts inside the i18n folder. Do you think we should also include that update to the documentation in this PR?

bc-andreadao commented 2 months ago

@jorgemoya Ah I see, thanks for clarifying. If you could help me make the changes to this PR that would work

jorgemoya commented 2 months ago

@bc-andreadao Yeah I will!

github-actions[bot] commented 2 months ago

⚡️🏠 Lighthouse report

Lighthouse ran against https://catalyst-latest-5y3jb7zpt-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 79
🟢 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 100
🟢 Accessibility 100
🟢 Best practices 96
🟠 SEO 85