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

Add docs for i18n in paper #194

Merged
merged 6 commits into from
Aug 13, 2023
Merged

Add docs for i18n in paper #194

merged 6 commits into from
Aug 13, 2023

Conversation

Machine-Maker
Copy link
Member

part of #190

Copy link
Member

@kennytv kennytv left a comment

Choose a reason for hiding this comment

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

Also needs at least a short code example

docs/paper/dev/api/component-api/i18n.md Outdated Show resolved Hide resolved
docs/paper/dev/api/component-api/i18n.md Outdated Show resolved Hide resolved
docs/paper/dev/api/component-api/i18n.md Outdated Show resolved Hide resolved
@Machine-Maker
Copy link
Member Author

Ok, added an example using ResourceBundle. Do we need to add an example of a custom Translator implementation? I don't really think its needed.

@olijeffers0n
Copy link
Member

As someone who hasn't used translatable components before, I would want an example of how to send these / create these components. Also, an explanation to what a translation key and/or what the translation files look like.

@Machine-Maker
Copy link
Member Author

As someone who hasn't used translatable components before, I would want an example of how to send these / create these components. Also, an explanation to what a translation key and/or what the translation files look like.

Good call. We can talk about the Translatable interface here, and all the api types that implement that.

As for an example of a resource bundle file... that is just one implementation. You can create translations from any format you want, its not closed off.

Copy link
Member

@olijeffers0n olijeffers0n left a comment

Choose a reason for hiding this comment

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

Looks good, the only thing I would say is that it probably needs an example of using a translatable component

config/sidebar.paper.ts Outdated Show resolved Hide resolved
docs/paper/dev/api/component-api/i18n.md Outdated Show resolved Hide resolved
docs/paper/dev/api/component-api/i18n.md Show resolved Hide resolved
docs/paper/dev/api/component-api/i18n.md Outdated Show resolved Hide resolved
docs/paper/dev/api/component-api/i18n.md Show resolved Hide resolved
Copy link
Member

@olijeffers0n olijeffers0n left a comment

Choose a reason for hiding this comment

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

Looks good to me

@olijeffers0n olijeffers0n merged commit 37580c3 into main Aug 13, 2023
@Machine-Maker Machine-Maker deleted the feature/component/i18n branch August 13, 2023 20:31
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.

5 participants