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

i18n package documentation #2896

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

i18n package documentation #2896

wants to merge 7 commits into from

Conversation

VictorAvelar
Copy link
Member

Summary

Adds public documentation for the @commercetools/i18n package.

Description

Closes SHIELD-443

@changeset-bot
Copy link

changeset-bot bot commented Nov 28, 2022

⚠️ No Changeset found

Latest commit: ce4c35d

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

@github-actions
Copy link
Contributor

github-actions bot commented Nov 28, 2022

Deploy preview for merchant-center-application-kit ready!

✅ Preview
https://merchant-center-application-77dkenhms-commercetools.vercel.app
https://appkit-sha-e1bd0cd52412706faa843399ed89879bf1009e22.commercetools.vercel.app
https://appkit-pr-2896.commercetools.vercel.app

Built with commit ce4c35d.
This pull request is being automatically deployed with vercel-action

Copy link
Member

@emmenko emmenko left a comment

Choose a reason for hiding this comment

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

First contribution, nice! 🥳

@@ -103,6 +103,8 @@
# path: /api-reference/commercetools-frontend-i18n
Copy link
Member

Choose a reason for hiding this comment

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

Remove these two lines here ⬆️

Copy link
Member Author

Choose a reason for hiding this comment

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

Will do, completely missed them. 👍🏽


</Subtitle>

# Supported locales
Copy link
Member

Choose a reason for hiding this comment

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

The first section should probably be the Installation section, also to keep it consistent the other docs pages.

Copy link
Member Author

Choose a reason for hiding this comment

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

I tried to keep the existing structure but it makes sense to keep it consistent.

Comment on lines 20 to 29
**Using npm**

```sh
npm install --save @commercetools/i18n
```
**Using yarn**

```sh
yarn add @commercetools/i18n
```
Copy link
Member

Choose a reason for hiding this comment

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

Can you keep it consistent with the other similar docs pages?

Copy link
Member Author

Choose a reason for hiding this comment

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

Isn't an issue if you have the "copy to clipboard" button to put everything in the same code block?

yarn add @commercetools/i18n
```

# Usage
Copy link
Member

Choose a reason for hiding this comment

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

Usually I would like to focus on the page structure first. It's important to define it as it helps identifying the flow of the content and as a consequence where to put what info.

Let's maybe have a sync about it?

@emmenko emmenko marked this pull request as draft November 28, 2022 13:53
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