Translate docs #138
Translate docs #138
Conversation
This change translates the README.md file and all of the files in the `/documentation` directory into German (de), Spanish (es), French (fr), Hindi (hi), Portuguese (pt), Russian (ru), and Simplified Chinese (zh-CN). It creates new files for each translation, such as `README.de.md` for the German translation of the README, and places the translated documentation files in new language-specific subdirectories within the `/documentation` directory (e.g., `/documentation/de/`). It also moves the localized READMEs to the `documentation` folder and updates the main README to link to them.
This commit introduces a significant internationalization update by translating the project's README and the entire contents of the /documentation directory into seven additional languages: - German (de) - Spanish (es) - French (fr) - Hindi (hi) - Portuguese (pt) - Russian (ru) - Simplified Chinese (zh-CN) To better support this multilingual structure, the original English documentation has been moved from the root of the /documentation directory into a new `en/` subdirectory. All internal markdown links have been carefully updated across all files to ensure they point to the correct relative paths for the new localized directory structure. This includes updating the main README to link to the translated READMEs and ensuring all cross-references within the documentation files work correctly for each language.
There was a problem hiding this comment.
Pull Request Overview
This pull request adds comprehensive Chinese (Simplified), Russian, and Portuguese translations for the AppState documentation. The translations cover the complete documentation suite including installation guides, usage examples, advanced topics, and best practices. Additionally, it introduces new translated files for German and Spanish documentation.
Key changes include:
- Added full translated documentation sets for Chinese (zh-CN), Russian (ru), and Portuguese (pt) languages
- Created comprehensive usage guides for all AppState components (SyncState, StoredState, FileState, SecureState, etc.)
- Translated advanced topics including migration considerations, implementation guides, and best practices
- Provided localized installation instructions and FAQ sections
Reviewed Changes
Copilot reviewed 120 out of 136 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| documentation/zh-CN/*.md | Complete Chinese (Simplified) documentation covering all AppState features and usage patterns |
| documentation/ru/*.md | Full Russian translation of documentation including installation, usage guides, and advanced topics |
| documentation/pt/*.md | Comprehensive Portuguese documentation with examples and best practices |
Comments suppressed due to low confidence (2)
documentation/ru/usage-syncstate.md:125
- [nitpick] The link text should be translated consistently with the rest of the documentation. Consider translating 'Starting to use SyncState' to Russian.
Чтобы включить синхронизацию iCloud, убедитесь, что вы следуете этому руководству, чтобы включить возможность хранилища ключ-значение iCloud: [Начало работы с SyncState](https://github.com/0xLeif/AppState/wiki/Starting-to-use-SyncState).
documentation/pt/usage-syncstate.md:125
- [nitpick] The link text should be translated consistently with the rest of the documentation. Consider translating 'Starting to use SyncState' to Portuguese.
Para habilitar a sincronização do iCloud, certifique-se de seguir este guia para habilitar a capacidade de Armazenamento de Chave-Valor do iCloud: [Começando a usar o SyncState](https://github.com/0xLeif/AppState/wiki/Starting-to-use-SyncState).
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @0xLeif, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly enhances the project's documentation by introducing comprehensive multilingual support and improving its structural organization. The primary goal is to make the documentation more accessible to a global audience by providing translated versions and streamlining navigation.
Highlights
- Multilingual Access: Direct links to various translated documentation versions (Simplified Chinese, Spanish, French, Hindi, Portuguese, Russian, German) have been added to the main
README.mdfor quick access. - Documentation Structure Reorganization: All existing English documentation links in
README.mdhave been updated to point to a dedicateddocumentation/en/subfolder, establishing a clear and organized structure for language-specific content. - New Translated Documentation: Full German (
documentation/README.de.md) and Spanish (documentation/README.es.md) documentation files have been introduced, covering installation, usage, features, and contribution guidelines. - English Documentation Relocation: All original English documentation files have been moved into a new
documentation/en/directory to accommodate the new multilingual structure and maintain consistency.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request is a great step towards making the documentation accessible to a wider audience by adding translations and reorganizing the file structure. The changes are well-structured. I've found a few minor copy-paste errors in the translated markdown files, which I've pointed out in the comments. Once these are addressed, this PR will be in great shape.
* Fix translations and add disclaimer to docs * Fix translations and add disclaimer to docs --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request does a great job of adding translations and restructuring the documentation for multilingual support. The new file structure is a good step towards better organization. I have a few suggestions to further improve the documentation's usability and correctness:
- The language links in the main
README.mdcould be sorted alphabetically for easier navigation. - There's a broken link to a GitHub wiki page in the
usage-syncstate.mdfiles across all languages. - The link for the translation tool 'Jules' seems to be a placeholder and should be updated or removed.
Additionally, for better consistency, you might consider placing the translated README.<lang>.md files inside their respective language folders (e.g., documentation/de/README.md). This would group all files for a given language in one place. This is just a suggestion for future improvement and not a blocker for this PR.
* Add SyncState documentation and update links * Update documentation/es/starting-to-use-syncstate.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update documentation/fr/starting-to-use-syncstate.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update documentation/de/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/en/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/en/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/fr/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/hi/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/pt/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/ru/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
#141) * This commit addresses the task of reviewing and improving the machine-translated documentation in the repository. As a professional translator, I systematically reviewed the documentation for the following languages: Spanish (es), German (de), French (fr), Hindi (hi), Portuguese (pt), Russian (ru), and Chinese (zh-CN). The following changes were made across all reviewed languages: - **Correction of Errors**: Fixed typos, grammatical mistakes, and awkward phrasing to enhance readability and professional tone. - **Disclaimer Standardization**: Replaced the existing machine-translation disclaimer with a consistent and more professional version across all translated files. - **Formatting Fixes**: Addressed minor formatting issues, such as adding missing titles to some documents to improve structure. The review was conducted on a file-by-file basis for each language, comparing the translation with the original English source to ensure accuracy and fluency. The review for all languages except Chinese is complete. The review for the Chinese (zh-CN) documentation is nearly complete, with 15 out of 17 files reviewed and corrected. * Update migration-considerations.md --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
This pull request updates the documentation to improve multilingual support and reorganize the structure for easier access to language-specific guides. The main changes include adding links to translated documentation in the
README.md, updating all documentation links to point to language-specific subfolders, and introducing new translated documentation files for German and Spanish.Multilingual documentation support:
README.md, linking to documentation in Simplified Chinese, Spanish, French, Hindi, Portuguese, Russian, and German.README.mdto point to the English-specific subfolder (documentation/en/). [1] [2]New translated documentation:
documentation/README.de.md) covering installation, usage, features, and contribution guidelines.documentation/README.es.md) with similar coverage and structure as the German version.