Skip to content

docs: update readme#368

Merged
e06084 merged 1 commit intoMigoXLab:devfrom
e06084:dev
Mar 23, 2026
Merged

docs: update readme#368
e06084 merged 1 commit intoMigoXLab:devfrom
e06084:dev

Conversation

@e06084
Copy link
Copy Markdown
Collaborator

@e06084 e06084 commented Mar 23, 2026

No description provided.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 refining the project's documentation across multiple languages. It streamlines the README files by removing obsolete demo instructions and significantly expands the content related to data quality metrics and advanced agent-based evaluation techniques. The updates aim to provide a more current, detailed, and user-friendly guide to the project's core functionalities.

Highlights

  • Documentation Cleanup: Outdated sections related to GUI Visualization, Online Demo, Local Demo, and Google Colab Demo were removed from the main README.md and its Japanese and Chinese localized versions.
  • Enhanced Data Quality Metrics Section: A comprehensive 'Data Quality Metrics' section was introduced and positioned prominently in README.md, README_ja.md, and README_zh-CN.md. This section details over 70 evaluation metrics, their categories, use cases, and provides quick usage examples with Python code.
  • Agent-Based Evaluation Details (Japanese README): The README_ja.md file received significant updates with new content explaining 'Agent-based evaluation and tools', including two implementation patterns (LangChain-based and Custom Workflow), built-in agents, and practical code examples for customization.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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.

Footnotes

  1. 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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 updates the README files in English, Japanese, and Chinese. The changes involve removing outdated demo sections and reorganizing the content to improve readability, notably by moving the "Data Quality Metrics" section higher up. The Japanese README is also updated with new sections about agent-based features to align it with the other versions. My review identifies an issue in the Japanese README where several documentation links incorrectly point to Chinese versions instead of the English ones, which could be confusing for readers. I've suggested corrections to ensure consistency and provide a better user experience.

Comment on lines +247 to +249
📖 **[RAG 評価ガイド →](docs/rag_evaluation_metrics_zh.md)**
🔍 **[幻覚検出ガイド →](docs/hallucination_guide.md)**
✅ **[事実性評価ガイド →](docs/factcheck_guide.md)**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The links for "RAG 評価ガイド", "幻覚検出ガイド", and "事実性評価ガイド" point only to the Chinese versions of the documentation. For consistency and a better user experience for Japanese readers, it would be better to link to the English versions and provide an optional link to the Chinese versions, similar to how it's done for the "VLM レンダリング判定ガイド" on line 250.

Suggested change
📖 **[RAG 評価ガイド →](docs/rag_evaluation_metrics_zh.md)**
🔍 **[幻覚検出ガイド →](docs/hallucination_guide.md)**
**[事実性評価ガイド →](docs/factcheck_guide.md)**
📖 **[RAG 評価ガイド →](docs/rag_evaluation_metrics.md)** | **[中文版](docs/rag_evaluation_metrics_zh.md)**
🔍 **[幻覚検出ガイド →](docs/hallucination_detection_guide.md)** | **[中文版](docs/hallucination_guide.md)**
**[事実性評価ガイド →](docs/factuality_assessment_guide.md)** | **[中文版](docs/factcheck_guide.md)**

@e06084 e06084 merged commit af7dfa2 into MigoXLab:dev Mar 23, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant