diff --git a/translations.mdx b/translations.mdx index d9c79a8e9..1ed9911ba 100644 --- a/translations.mdx +++ b/translations.mdx @@ -123,6 +123,36 @@ To make your documentation more translatable and easier to read in English, **av * **Avoid**: "This feature hits it out of the park." * **Better**: "This feature provides excellent results." +## Glossary Feature + +The glossary feature allows you to specify words and terms that should remain untranslated across all languages. When you add words to your glossary, the translation service will preserve these terms exactly as they appear in your English documentation, ensuring consistency and accuracy across all language versions. + +### How it works + +Words included in your glossary remain untranslated in all target languages. The translation system recognizes these terms and preserves them in their original form, regardless of the target language. This ensures that important terms maintain their intended meaning and recognition across different language versions of your documentation. + +### When to use the glossary + +The glossary feature is particularly valuable for: + +- **Brand names**: Company names, product names, and service names that should maintain brand recognition + - Example: Adding "Mintlify" to the glossary ensures it never gets translated to another word in any language +- **Product names**: Specific product or feature names that users need to recognize consistently + - Example: "GitHub," "API," "OAuth" +- **Technical terms**: Industry-specific terminology that doesn't have direct translations or should remain standardized + - Example: "webhook," "middleware," "SDK" +- **Proprietary terminology**: Custom terms specific to your organization or product + - Example: Custom component names, internal system names + +### Value for users + +Using the glossary feature provides several key benefits: + +- **Brand consistency**: Maintains brand recognition and trust across all language versions by preserving brand names and product terminology +- **Accurate technical documentation**: Ensures technical terms remain precise and recognizable to developers and technical users regardless of their language preference +- **Better user experience**: Prevents confusion that could arise from translated technical terms or brand names, allowing users to easily follow instructions and understand references across different language versions +- **Professional presentation**: Maintains the professional appearance of your documentation by preserving industry-standard terminology and proper nouns + ## Troubleshooting and FAQs @@ -172,4 +202,14 @@ To make your documentation more translatable and easier to read in English, **av The translation service does not support custom translation rules for specific terms or phrases. We are developing this feature for a future release. - + + --- + + ## Join Our Team + + Are you an AI backend engineer passionate about improving multilingual documentation? We're hiring talented engineers to work on the future of AI translations and documentation tools. + + + Join us in building the next generation of AI-powered documentation tools + + \ No newline at end of file