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
base: main
Are you sure you want to change the base?
Conversation
|
website/src/content/api-reference/commercetools-frontend-i18n.mdx
Outdated
Show resolved
Hide resolved
website/src/content/api-reference/commercetools-frontend-i18n.mdx
Outdated
Show resolved
Hide resolved
Deploy preview for merchant-center-application-kit ready! ✅ Preview Built with commit ce4c35d. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First contribution, nice! 🥳
website/src/data/navigation.yaml
Outdated
@@ -103,6 +103,8 @@ | |||
# path: /api-reference/commercetools-frontend-i18n |
There was a problem hiding this comment.
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 ⬆️
There was a problem hiding this comment.
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. 👍🏽
website/src/content/api-reference/commercetools-frontend-i18n.mdx
Outdated
Show resolved
Hide resolved
|
||
</Subtitle> | ||
|
||
# Supported locales |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
**Using npm** | ||
|
||
```sh | ||
npm install --save @commercetools/i18n | ||
``` | ||
**Using yarn** | ||
|
||
```sh | ||
yarn add @commercetools/i18n | ||
``` |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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?
Co-authored-by: Nicola Molinari <nicola.molinari@commercetools.com>
Summary
Adds public documentation for the
@commercetools/i18n
package.Description
Closes SHIELD-443