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 translation information #916

Open
1 task
Arzh42 opened this issue Aug 19, 2024 · 4 comments
Open
1 task

docs: Add translation information #916

Arzh42 opened this issue Aug 19, 2024 · 4 comments
Labels
📚 documentation ✨ enhancement suggestion or feature request to improve uploadthing planned We would like this to happen PRs Accepted Anyone feel free to pick this up

Comments

@Arzh42
Copy link

Arzh42 commented Aug 19, 2024

Area of Improvement

Hello, first thank you for the product it is really a pleasure to work with it !!

However, I'm a french developer and working for french users and it was a bit difficult to find a way to translate the components. A translation directly included in the product would have been perfect 😉 but I think a simple addition to the theming part of the documentation (like theming/translation) giving an example on how to translate easily would have made my work a lot easier and should not take too much time to do.

Also the documentation for content may need more content like describing how ContentField work, I wasn't able to work with it without diving into the typescript code and it may be not accessible for more junior devs.

I may do a PR later on based on my example if I find the time to do it

Link to related docs

https://docs.uploadthing.com/theming#content-customisation

Additional information

No response

👨‍👧‍👦 Contributing

  • 🙋‍♂️ Yes, I'd be down to file a PR implementing the suggested changes!
@markflorkowski markflorkowski added planned We would like this to happen ✨ enhancement suggestion or feature request to improve uploadthing PRs Accepted Anyone feel free to pick this up labels Aug 19, 2024
@markflorkowski
Copy link
Collaborator

I agree, I would be hesitant to maintain the translations "natively" since that could so quickly explode in size for a feature many users may not use, but this is probably something we should have in the documentation. PRs are definitely welcome to update the theming docs!

@Bashamega
Copy link
Contributor

Do you mean to make the components more customizable so you can add your custom text?

@markflorkowski
Copy link
Collaborator

Do you mean to make the components more customizable so you can add your custom text?

This is already possible with content customization, but there is definitely room for improvement. #947 will help with this, but thgere is also room for documentation on how to use these features for the purpose of internationalization.

@Arzh42
Copy link
Author

Arzh42 commented Oct 4, 2024

Yes I succeed to use the tool has it is my issue was only that it took me a long time to understand how to use it for the purpose of internationalization so just a bit more work on documentation. (I am still watching this issue because I hope to have time to do the bit of documentation soon)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation ✨ enhancement suggestion or feature request to improve uploadthing planned We would like this to happen PRs Accepted Anyone feel free to pick this up
Projects
None yet
Development

No branches or pull requests

3 participants