Optimize Installation and Development Doc

[pan-x-c]

Description

1. Simplify installation instruction and add a separate Installation Guide.
2. Split the Developer Guide into Workflow / Algorithm / Operator Development Guide
3. Optimize document directory structure

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 @pan-x-c, 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 upgrade to the project's documentation, focusing on improving clarity, organization, and developer onboarding. It consolidates installation procedures, introduces uv for faster package management, and provides a suite of new, detailed Chinese-language guides for extending core framework components like algorithms, operators, and workflows. These changes aim to make the project more accessible and easier to contribute to.

Highlights

• Documentation Restructuring: The project's documentation has undergone a significant reorganization, centralizing installation instructions into a new, comprehensive guide and streamlining the main README files.
• New Developer Guides (Chinese): Several new, in-depth developer guides have been added in Chinese, providing detailed instructions on how to implement and integrate custom algorithms, data operators, and interaction workflows within the Trinity-RFT framework.
• Streamlined Installation Process: Installation instructions in both English and Chinese READMEs have been refined for clarity and conciseness, including the introduction of uv as a modern and faster package installer option.
• Advanced Configuration Guide: A new advanced guide has been added to explain how to extend the graphical configuration generator, detailing the process of adding new configuration parameters using Streamlit.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/docker/docker-compose.yaml

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 significantly improves the documentation by optimizing the installation and developer guides. The changes centralize installation instructions into dedicated files and break down a large programming guide into smaller, more focused documents for both English and Chinese versions. This refactoring enhances the clarity, maintainability, and user-friendliness of the documentation. My review includes a few suggestions to fix minor inconsistencies in comments, headings, and section numbering to further polish these improvements.

[Copilot]

Pull Request Overview

This pull request optimizes the installation and development documentation for Trinity-RFT by reorganizing and improving both Chinese and English documentation structures. The PR consolidates installation instructions, breaks down development guides, and improves overall documentation organization.

Key changes include:

• Created dedicated installation guides with comprehensive coverage of different installation methods
• Split the large programming guide into smaller, focused development guides for workflows, algorithms, and operators
• Reorganized documentation structure for better navigation and usability

Reviewed Changes

Copilot reviewed 26 out of 26 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
pyproject.toml	Added UV package manager configuration for flash-attn dependencies
docs/sphinx_doc/source_zh/tutorial/trinity_programming_guide.md	Removed comprehensive programming guide (747 lines deleted)
docs/sphinx_doc/source_zh/tutorial/trinity_installation.md	Added new Chinese installation guide covering all installation methods
docs/sphinx_doc/source_zh/tutorial/develop_*.md	Created modular development guides for workflows, algorithms, and operators
docs/sphinx_doc/source_zh/tutorial/trinity_configs.md	Added configuration generator section to existing config documentation
docs/sphinx_doc/source_zh/index.rst	Restructured documentation navigation with separate "教程" and "样例" sections
docs/sphinx_doc/source/tutorial/*.md	Mirror changes made to Chinese documentation in English versions
README*.md	Updated installation sections to reference new installation guides
.github/workflows/docker/docker-compose.yaml	Updated Docker image version tags

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}