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: add localization overview & guide #1332

Merged
merged 3 commits into from
Sep 6, 2024

Conversation

bc-andreadao
Copy link
Collaborator

@bc-andreadao bc-andreadao commented Sep 4, 2024

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

@bc-andreadao bc-andreadao requested a review from a team as a code owner September 4, 2024 18:50
Copy link

changeset-bot bot commented Sep 4, 2024

⚠️ No Changeset found

Latest commit: 36253bc

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

Copy link

vercel bot commented Sep 4, 2024

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) Sep 6, 2024 7:39pm
catalyst-1millionproducts-store ⬜️ Ignored (Inspect) Visit Preview Sep 6, 2024 7:39pm
catalyst-au ⬜️ Ignored (Inspect) Visit Preview Sep 6, 2024 7:39pm
catalyst-staging ⬜️ Ignored (Inspect) Visit Preview Sep 6, 2024 7:39pm
catalyst-test-store ⬜️ Ignored (Inspect) Visit Preview Sep 6, 2024 7:39pm
catalyst-uk ⬜️ Ignored (Inspect) Visit Preview Sep 6, 2024 7:39pm
catalyst-unstable ⬜️ Ignored (Inspect) Visit Preview Sep 6, 2024 7:39pm

@jorgemoya
Copy link
Contributor

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

@bc-andreadao
Copy link
Collaborator Author

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

@jorgemoya
Copy link
Contributor

jorgemoya commented Sep 5, 2024

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
Copy link
Collaborator Author

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

@jorgemoya
Copy link
Contributor

@bc-andreadao Yeah I will!

@jorgemoya jorgemoya added this pull request to the merge queue Sep 6, 2024
Merged via the queue into main with commit 18183cf Sep 6, 2024
7 of 11 checks passed
@jorgemoya jorgemoya deleted the DEVDOCS-6062-directory-change branch September 6, 2024 19:37
Copy link
Contributor

github-actions bot commented Sep 6, 2024

⚡️🏠 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

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.

3 participants