-
-
Notifications
You must be signed in to change notification settings - Fork 3
Add SyncState documentation and update links #140
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request adds documentation disclaimers across multiple language versions and fixes minor translation errors in Spanish and Portuguese documentation. The changes help clarify that the translated documentation was generated using Jules and may contain errors, encouraging native speakers to submit corrections.
- Added disclaimers to all non-English documentation files stating the content was AI-generated and requesting native speaker corrections
- Fixed translation errors in Spanish (changed "в una extensión" to "en una extensión") and Portuguese (corrected "и injete" to "e injete" and "Guida" to "Guia")
- Updated internal links to use relative paths instead of GitHub wiki URLs
Reviewed Changes
Copilot reviewed 128 out of 128 changed files in this pull request and generated 2 comments.
Show a summary per file
File | Description |
---|---|
documentation/{lang}/*.md | Added disclaimers to all documentation files in Chinese, Russian, Portuguese, Hindi, French, Spanish, and German |
documentation/README.{lang}.md | Added disclaimers to translated README files |
documentation/{lang}/usage-syncstate.md | Updated links from GitHub wiki to local markdown files |
documentation/es/README.es.md | Fixed Spanish translation error "в una extensión" to "en una extensión" |
documentation/pt/README.pt.md | Fixed Portuguese translation errors "и injete" to "e injete" and "Guida" to "Guia" |
documentation/fr/faq.md | Fixed French translation error "могут se poser" to "peuvent se poser" |
documentation/de/usage-storedstate.md | Fixed German translation error "не sensible" to "nicht sensible" |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 focuses on enhancing the quality and clarity of the AppState documentation across multiple languages. Key changes include the addition of a disclaimer to various translated documentation files, indicating their AI-generated origin and inviting community contributions for accuracy. Furthermore, specific translation errors in Spanish and Portuguese documentation have been rectified, and new detailed instructions for setting up iCloud capabilities for SyncState have been introduced. These updates aim to improve the overall user experience and foster community involvement in maintaining accurate documentation.
Highlights
- Addition of Documentation Generation Disclaimer: A disclaimer has been added to numerous documentation files across German, French, Spanish, Portuguese, Russian, Hindi, and Chinese languages. This disclaimer clarifies that the content was generated using 'Jules' and may contain errors, actively encouraging native speakers to contribute corrections via pull requests.
- Correction of Translation Errors: Minor translation errors have been corrected in the Spanish and Portuguese documentation. Specifically, a Spanish code comment was fixed from "в una extensión" to "en una extensión", and Portuguese documentation saw corrections from "и injete dependências" to "e injete dependências" and "Guida de Uso do FileState" to "Guia de Uso do FileState".
- New SyncState Setup Documentation: New documentation content has been added to guide users on setting up iCloud capabilities and permissions for using SyncState in Xcode projects. This new section provides step-by-step instructions to facilitate the integration of SyncState.
- Update of SyncState Documentation Links: Links within the SyncState documentation across various languages have been updated. Previously pointing to a GitHub wiki, these links now direct to relative markdown paths within the repository, improving navigation and 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. ↩
c40db09
to
90cc1b1
Compare
/gemini review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request improves the documentation by adding a disclaimer about auto-translation and fixing several translation errors. It also adds new documentation for SyncState
setup across multiple languages and updates internal links. The changes are mostly good, but I've found a few minor typos and translation errors in the new documentation files that should be addressed to improve clarity and correctness.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds new documentation for setting up SyncState
and updates existing documentation to use local links instead of external ones. The changes are well-structured and improve the documentation. I've found a couple of minor translation errors in the new Spanish and French documentation files and have provided suggestions to fix them. Overall, this is a good improvement.
Co-authored-by: Copilot <175728472+Copilot@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>
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>
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>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
/gemini review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds new documentation for SyncState
setup across multiple languages and updates existing documentation to link to these new files. This is a great addition that makes the documentation more self-contained and easier to navigate.
I've found a couple of minor inconsistencies in the translated documentation files that should be addressed for clarity and accuracy:
- The Xcode UI label "Signing & Capabilities" is incorrectly referenced in all translated versions.
- A placeholder for the key-value store ID has been translated, which is inconsistent with other technical identifiers in the same line.
I've added specific comments with suggestions for each affected file. Overall, great work on expanding the documentation.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
/gemini review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds new documentation for SyncState
and updates existing links to point to these new local files. The changes are well-structured and improve the documentation by making it self-contained. I've found a couple of minor issues in the translated documents: a typo in the Spanish documentation and a punctuation inconsistency in the Hindi documentation. Please see my detailed comments for suggestions.
### Actualización de los derechos: | ||
|
||
1. Ahora deberá actualizar su archivo de derechos. Abra el archivo de derechos para su destino. | ||
2. Asegúrese de que el valor del Almacén de clave-valor de iCloud coincida con su ID de almacén de clave-valor único. Su ID único debe seguir el formato `$(TeamIdentifierPrefix)<your key-value store ID>`. El valor predeterminado debería ser algo así como `$(TeamIdentifierPrefix)$(CFBundleIdentifier)`. Esto está bien para aplicaciones de una sola plataforma, pero si su aplicación está en varios sistemas operativos de Apple, es importante que las partes de la ID del almacén de clave-valor sean las mesmas para ambos destinos. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a small translation error here. The word "mesmas" is Portuguese. The correct Spanish word is "mismas".
2. Asegúrese de que el valor del Almacén de clave-valor de iCloud coincida con su ID de almacén de clave-valor único. Su ID único debe seguir el formato `$(TeamIdentifierPrefix)<your key-value store ID>`. El valor predeterminado debería ser algo así como `$(TeamIdentifierPrefix)$(CFBundleIdentifier)`. Esto está bien para aplicaciones de una sola plataforma, pero si su aplicación está en varios sistemas operativos de Apple, es importante que las partes de la ID del almacén de clave-valor sean las mesmas para ambos destinos. | |
2. Asegúrese de que el valor del Almacén de clave-valor de iCloud coincida con su ID de almacén de clave-valor único. Su ID único debe seguir el formato `$(TeamIdentifierPrefix)<your key-value store ID>`. El valor predeterminado debería ser algo así como `$(TeamIdentifierPrefix)$(CFBundleIdentifier)`. Esto está bien para aplicaciones de una sola plataforma, pero si su aplicación está en varios sistemas operativos de Apple, es importante que las partes de la ID del almacén de clave-valor sean las mismas para ambos destinos. |
@@ -122,7 +122,7 @@ struct SyncStateExampleApp: App { | |||
|
|||
### iCloud की-वैल्यू स्टोर सक्षम करना | |||
|
|||
iCloud सिंक्रनाइज़ेशन को सक्षम करने के लिए, सुनिश्चित करें कि आप iCloud की-वैल्यू स्टोर क्षमता को सक्षम करने के लिए इस गाइड का पालन करते हैं: [SyncState का उपयोग शुरू करना](https://github.com/0xLeif/AppState/wiki/Starting-to-use-SyncState)। | |||
iCloud सिंकिंग सक्षम करने के लिए, सुनिश्चित करें कि आप iCloud कुंजी-मूल्य संग्रहण क्षमता को सक्षम करने के लिए इस गाइड का पालन करते हैं: [SyncState का उपयोग शुरू करना](starting-to-use-syncstate.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line ends with a period (.
), but other sentences in the Hindi documentation (including the newly added starting-to-use-syncstate.md
file) consistently use the Devanagari danda (।
) as a full stop. For consistency, it would be better to use ।
here as well.
iCloud सिंकिंग सक्षम करने के लिए, सुनिश्चित करें कि आप iCloud कुंजी-मूल्य संग्रहण क्षमता को सक्षम करने के लिए इस गाइड का पालन करते हैं: [SyncState का उपयोग शुरू करना](starting-to-use-syncstate.md). | |
iCloud सिंकिंग सक्षम करने के लिए, सुनिश्चित करें कि आप iCloud कुंजी-मूल्य संग्रहण क्षमता को सक्षम करने के लिए इस गाइड का पालन करते हैं: [SyncState का उपयोग शुरू करना](starting-to-use-syncstate.md)। |
* Translate README and documentation into 7 languages * Translate README and documentation into 7 languages 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. * feat: Add comprehensive documentation translations 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. * Fix translations and add disclaimer to docs (#139) * 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> * Add SyncState documentation and update links (#140) * 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> * Update README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * This commit addresses the task of reviewing and improving the machine… (#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> --------- 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>
This pull request introduces minor improvements and clarifications to the documentation for AppState in multiple languages. The most important changes include the addition of a disclaimer to various documentation files indicating that the content was generated using Jules and may contain errors, encouraging native speakers to submit corrections via pull requests. There are also small corrections to translation errors in Spanish and Portuguese documentation.
Documentation generation disclaimer (added across all supported languages):
de
), French (fr
), Spanish (es
), Portuguese (pt
), Russian (ru
), Hindi (hi
), and Chinese (zh-CN
) stating that the content was generated using Jules and may contain errors, with a request for native speakers to submit corrections. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19]Translation corrections:
New documentation content:
documentation/de/starting-to-use-syncstate.md
with step-by-step instructions for setting up iCloud capabilities and permissions for using SyncState in Xcode projects.These changes help clarify the provenance of the documentation, invite community contributions for improvements, and correct minor translation errors to enhance the overall quality and accuracy of the documentation.