Update main readme

[yanxi-chen]

Description

Revise the beginning parts of main readme.

Checklist

Please check the following items before code is ready to be reviewed.

• Code has passed all tests
• Docstrings have been added/updated in Google Style
• Documentation has been updated
• Code is ready for review

[gemini-code-assist]

Summary of Changes

Hello @yanxi-chen, I'm Gemini Code Assist¹! 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 delivers a substantial update to the project's primary documentation, encompassing both the English and Chinese README files and their corresponding Sphinx documentation source files. The core objective is to present a more organized, detailed, and user-friendly overview of the Trinity-RFT framework. This includes clarifying the roles of its key components, elaborating on its utility for various user personas, and providing a significantly improved, categorized guide to available tutorials and resources.

Highlights

• Documentation Structure: The 'What is Trinity-RFT?' and 'Tutorials and Guidelines' sections in both English and Chinese READMEs and Sphinx documentation have been significantly restructured and expanded for improved clarity.
• Enhanced Clarity and Detail: Descriptions of the core components (Explorer, Trainer, Buffer) and functionalities for different user roles (agent developers, RL researchers, data engineers) have been rewritten and expanded.
• Comprehensive Tutorial Listings: A new, detailed markdown table has been introduced for tutorials, categorizing them by RFT modes, multi-step agentic RL, full-lifecycle data pipelines, algorithm development, and deeper insights into the framework.
• Content Refinement: Minor text adjustments were made for better readability, including adding a line break in the main title and refining data pipeline descriptions, along with updating external hyperlinks.

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.

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

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

[gemini-code-assist]

Code Review

This pull request revises the introductory sections of the README files (both English and Chinese) and their corresponding Sphinx documentation source files. The changes improve the structure by reorganizing the 'What is Trinity-RFT?' section and adding a comprehensive 'Tutorials and Guidelines' table, which is a great addition for users. The English documentation changes look good. I've found a few issues in the Chinese documentation files (README_zh.md and docs/sphinx_doc/source_zh/main.md), including some incorrect links and a typo, and have provided suggestions to fix them.