tolgee / documentation Goto Github PK

https://tolgee.io/js-sdk/migration_to_v5/ngx

Page: https://tolgee.io/js-sdk/migration_to_v5/ngx

There may be an additional resource need: The initialization & configuration of Tolgee is described here.

here may need a link

I've got feedback from our of our users that the import and export are not well documented. Can you please review that?

"One thing that could be improved is the documentation and especially how the import functionality works; overall a more clear documentation on how the import/export works would be a very useful addition."

https://www.figma.com/file/UCvcqHZe6owmJV5QolBMoj/tolgee-tasks?node-id=125%3A934

Add examples of adding parameters to t function in react section. Also make somehow react example app more visible

There are references to MutationObserver, InvisibleObserver, which are not links:
https://tolgee.io/js-sdk/text-observer#when-to-use

There is no mention about TextWrapping, so there is no way the reader can get it right
https://tolgee.io/js-sdk/wrapping

Feedback of a user: in that screen size, the link to Blog is not fully visible. I would modify the breakpoints to show the burger menu there.

Based on tolgee/tolgee-js#3180

tolgee/tolgee-js#3230

https://tolgee.io/platform/projects_and_organizations/export

• Add the missing docs for the SDK change state
• Would be cool to replace the old app videos and screenshots

Feedback from a user: top and bottom margin in mobiles is too much

• The Api > API
• Better explanation of the units
• Credits > machine translation credits
• [ ]

• Add Calendly widget
• Add Video Ask
• Add curly arrow to the first screen of website
• Add Capterra button <a href="https://www.capterra.com/reviews/278005/Tolgee?utm_source=vendor&utm_medium=badge&utm_campaign=capterra_reviews_badge"> <img border="0" src="https://assets.capterra.com/badge/7da1869535ec85f42df2a7cc09e8d270.svg?v=2225987&p=278005" /> </a>

There is no information about providing project ID when using PAT, which might be confusing for the users.

We should briefly describe the difference.

https://tolgee.io/js-sdk/initialization

If a user comes to our docs and tries to search for language detection, how to automatically detect the user's language or whatever they'd try to search for, they only find brief plugin docs in https://tolgee.io/js-sdk/api/web_package/plugins#languagedetector.

But a bit more detailed guide about how it works, how it detects, how to use it, and when to use it is missing in the docs.

The section "Detecting user's language" is completely missing in the docs, and there are only references to the plugin, which is not optimal.

Contrast is not sufficient on some elements

tolgee/tolgee-platform#1002