Menu
Guidelines for translating G2 documentation, including terminology consistency, hyperlink adjustments, and file naming conventions for multilingual documentation. Use when need to translate documents.
Expert skill for G2 legend development - provides comprehensive knowledge about legend rendering implementation, component architecture, layout algorithms, and interaction handling. Use when implementing, customizing, or debugging legend functionality in G2 visualizations.
Guidelines and best practices for writing unit tests in the G2 visualization library, covering directory structure, testing patterns, and implementation guidelines. Use when need to generate test.
| name | G2 Translation Guidelines |
| description | Guidelines for translating G2 documentation, including terminology consistency, hyperlink adjustments, and file naming conventions for multilingual documentation. Use when need to translate documents. |
These guidelines provide comprehensive instructions for translating G2 documentation files, particularly those under the site/docs directory.
Ensure that terminology is consistent throughout the document. Use the glossary below to maintain uniformity in terms:
Review and adjust hyperlinks to ensure they point to the correct translated sections or documents. Verify that all links are functional and correctly formatted.
In the English version, all internal links should have a /en prefix, while the Chinese version should not have any prefix. Ensure this prefix is added to all internal links in English documents to avoid any oversight.
For anchor points following a #, if they contain Chinese characters, they should be adjusted to match the corresponding title in the English version rather than being directly translated.
Convert external links appropriately to ensure they align with the language and context of the document.
Translations should be stored in corresponding .en.md or .zh.md files within the same directory. Ensure that the translated content is placed in the correct location within the document.
.en.md file in the same directory..zh.md file in the same directory.Allow for the selection and translation of specific sections of content. Translated sections should be inserted into the appropriate location within the document, maintaining the logical flow and structure.
If the entire document is selected for translation, replace the entire content with the translated version.
If only specific sections are selected, find the appropriate place to replace or insert the translated content, ensuring the document's logical flow and structure are maintained.
Avoid literal translations. Ensure that the translation fits the English context and conveys the intended meaning accurately.
Translations should be directly modified in the corresponding .en.md or .zh.md files without returning the translated content separately. Ensure that the changes are saved in the correct file and location.
Do not modify the order attribute in the page metadata during translation. This ensures that the document order remains consistent across different language versions.
Ensure that all internal links in English documentation have the '/en' prefix to maintain consistency and correct navigation.
Always check if ${target_path} exists in the project structure; never create new files when translating existing documents.
By following these guidelines, translations will be more accurate and consistent, facilitating easier review and integration into the documentation.