You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
129
+
130
+
### How it works
131
+
132
+
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.
133
+
134
+
### When to use the glossary
135
+
136
+
The glossary feature is particularly valuable for:
137
+
138
+
-**Brand names**: Company names, product names, and service names that should maintain brand recognition
139
+
- Example: Adding "Mintlify" to the glossary ensures it never gets translated to another word in any language
140
+
-**Product names**: Specific product or feature names that users need to recognize consistently
141
+
- Example: "GitHub," "API," "OAuth"
142
+
-**Technical terms**: Industry-specific terminology that doesn't have direct translations or should remain standardized
143
+
- Example: "webhook," "middleware," "SDK"
144
+
-**Proprietary terminology**: Custom terms specific to your organization or product
145
+
- Example: Custom component names, internal system names
146
+
147
+
### Value for users
148
+
149
+
Using the glossary feature provides several key benefits:
150
+
151
+
-**Brand consistency**: Maintains brand recognition and trust across all language versions by preserving brand names and product terminology
152
+
-**Accurate technical documentation**: Ensures technical terms remain precise and recognizable to developers and technical users regardless of their language preference
153
+
-**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
154
+
-**Professional presentation**: Maintains the professional appearance of your documentation by preserving industry-standard terminology and proper nouns
155
+
126
156
## Troubleshooting and FAQs
127
157
128
158
<AccordionGroup>
@@ -172,4 +202,4 @@ To make your documentation more translatable and easier to read in English, **av
172
202
<Accordiontitle="Can I define specific translations for words or prevent terms from being translated?">
173
203
The translation service does not support custom translation rules for specific terms or phrases. We are developing this feature for a future release.
0 commit comments