-
Notifications
You must be signed in to change notification settings - Fork 18
docs: Auto-translate README and Wiki #292
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
base: main
Are you sure you want to change the base?
docs: Auto-translate README and Wiki #292
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.
Summary of Changes
Hello @openaitx-system, 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 accessibility of the project's documentation by introducing an automated translation system for the README and Wiki. It integrates a language selection dropdown directly into the README.md file, providing users with immediate access to translated content in numerous languages. This initiative aims to broaden the project's reach and improve its discoverability through multi-language search engine optimization.
Highlights
- Enhanced Documentation Accessibility: A new language selection dropdown has been added to the top right of the
README.mdfile, allowing users to easily switch between different language versions of the documentation. - Multi-language Support: The PR enables access to auto-translated versions of the README and Wiki in 20 different languages, including major languages like German, Spanish, French, Japanese, Korean, Portuguese, and Russian.
- Automated Translation and SEO Improvement: The proposed system is designed to automatically update translations for the README and Wiki whenever the repository is updated, which also aims to improve multi-language search engine optimization (SEO).
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. ↩
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #292 +/- ##
=====================================
Coverage 94.6% 94.6%
=====================================
Files 3 3
Lines 225 225
=====================================
Hits 213 213
Misses 9 9
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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 a language selector to the README.md file, providing links to auto-translated versions of the documentation. This is a helpful feature for making the project more accessible to a global audience. I've found a couple of issues in the HTML implementation: a malformed <a> tag that will break rendering, and a minor formatting issue in the <summary> tag. Addressing these points will ensure the new feature works as intended.
| | <a href="https://openaitx.github.io/view.html?user=ravilushqa&project=otelgqlgen&lang=tr">Türkçe</a> | ||
| | <a href="https://openaitx.github.io/view.html?user=ravilushqa&project=otelgqlgen&lang=vi">Tiếng Việt</a> | ||
| | <a href="https://openaitx.github.io/view.html?user=ravilushqa&project=otelgqlgen&lang=id">Bahasa Indonesia</a> | ||
| | <a href="https://openaitx.github.io/view.html?user=ravilushqa&project=otelgqlgen&lang=as">অসমীয়া</ |
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.
The closing </a> tag is missing for the Assamese language link. This is invalid HTML and will cause rendering issues for the content inside the dropdown menu.
| | <a href="https://openaitx.github.io/view.html?user=ravilushqa&project=otelgqlgen&lang=as">অসমীয়া</ | |
| | <a href="https://openaitx.github.io/view.html?user=ravilushqa&project=otelgqlgen&lang=as">অসমীয়া</a> |
|
|
||
| <div align="right"> | ||
| <details> | ||
| <summary >🌐 Language</summary> |
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.
Added language badges to the README for easier access to translated versions: German, Spanish, French, Japanese, Korean, Portuguese, and Russian 20 languages.
System will auto-update translation for README and Wiki when this repository updated, and support multiple languages google/bing SEO search, and it's open source project, we can change web or local file mode.
The updated links can be previewed in my forked repository: https://github.com/openaitx-system/otelgqlgen/tree/Auto_translate_README_and_Wiki
Demo links :
..
If this doesn't align with your expectations, feel free to close this PR. Thanks for your time! 🙌