Skip to content

Conversation

@Harry-Yu-Shuhang
Copy link
Member

Update Docker in quick start, which is the easiest way for beginners.

@gemini-code-assist
Copy link

Summary of Changes

Hello @Harry-Yu-Shuhang, 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 project's documentation by integrating Docker as a primary quick-start option and overhauling the Docker deployment guide. The changes aim to simplify the setup process for new users, particularly those unfamiliar with command-line Docker, by providing a comprehensive, step-by-step guide for Docker Desktop, alongside practical advice for common issues like network access in certain regions.

Highlights

  • Enhanced Quick Start Guide: The main quick start document now includes a dedicated section for Docker, positioning it as the easiest setup method for beginners and providing clear guidance on how to proceed with or without Docker.
  • Detailed Docker Desktop Guide: The Docker deployment documentation has been completely revised to focus on Docker Desktop, offering step-by-step instructions for downloading, installing, and configuring it across different operating systems (Windows, macOS with Intel/Apple Silicon).
  • Improved User Guidance and Accessibility: New informational and warning blocks have been added to guide users, including advice for mainland Chinese users facing network issues with Docker Hub and contact information for Docker image maintenance. The Docker guide's sidebar position has also been updated for better visibility.
  • Documentation Structure Modernization: The Docker deployment guide now utilizes Docusaurus Tabs for clearer presentation of OS-specific instructions, making the content more organized and user-friendly.
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

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.

Copy link

@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

您好,感谢您为改善 Docker 快速启动文档所做的贡献。新的面向初学者的 Docker Desktop 指南写得非常清晰易懂,这是一个很棒的改进。

我的反馈主要集中在 docs/user-guide/backend/docker.md 文件上。在重构文档以方便新用户的同时,一些对高级用户至关重要的信息(如命令行部署指令)以及所有用户都应了解的系统要求(如 GPU 支持、镜像大小)被意外移除了。我提供了一些具体的建议来补充这些缺失的内容,以确保文档的完整性,能够服务于所有不同技术水平的用户。

除此之外,还有一些小的拼写和格式建议,以提高文档的专业性。请查看具体的评论。谢谢!

import TabItem from '@theme/TabItem';

# Docker 部署

Choose a reason for hiding this comment

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

high

您好,这次更新移除了旧文档中的“使用须知”和“预装模型说明”部分,其中包含了一些关键信息,例如:

  • 镜像体积
  • 对 NVIDIA GPU 的要求及 NVIDIA Container Toolkit
  • 远程部署时需要 HTTPS
  • 默认预装的模型以及如何包含可选模型

这些信息对于用户评估硬件需求、环境配置和功能选择至关重要,即使是使用 Docker Desktop 的用户也需要了解。建议在文档开头位置重新加入一个“部署要求”或“注意事项”部分,以确保用户能够顺利部署。

- 首次启动时,Docker Desktop 会要求您登录 Docker Hub 账号。如果您没有账号,需要先注册一个。

5. 访问 `localhost:12393` 进行测试
## 使用终端命令

Choose a reason for hiding this comment

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

high

您好,感谢您更新 Docker 文档。新的 Docker Desktop 指南写得非常清晰。不过,我注意到 ## 使用终端命令 部分目前是空的,并且之前版本中关于 docker builddocker run 的命令行指令被移除了。这部分内容对于习惯使用命令行的用户来说非常重要,建议您将这部分内容补充完整,以便所有用户都能找到适合自己的部署方式。

:::danger
由于重构幅度较大,Docker 镜像暂时还没有更新到 `v1.0.0` 版本,但是很快会更新
:::info 关于安装方式的说明
目前有两种安装方式,如果您是小白,推荐您[使用Docker DeskTop](#使用docker-desktop)。如果您对Docker比较熟悉,也可以[使用终端命令](#使用终端命令)

Choose a reason for hiding this comment

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

medium

这里有一个小的拼写建议,DeskTop 应该是 Desktop

Suggested change
目前有两种安装方式,如果您是小白,推荐您[使用Docker DeskTop](#使用docker-desktop)。如果您对Docker比较熟悉,也可以[使用终端命令](#使用终端命令)
目前有两种安装方式,如果您是小白,推荐您[使用Docker Desktop](#使用docker-desktop)。如果您对Docker比较熟悉,也可以[使用终端命令](#使用终端命令)

:::warning
⚠️ 请注意:此功能目前处于实验阶段,但在大多数情况下可以正常工作
:::note
我们在 docker hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members),目前docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。如果docker镜像有问题,可以联系他(邮箱: [email protected])

Choose a reason for hiding this comment

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

medium

为了与文档其他部分保持一致,建议将 docker hubdocker镜像 中的 docker 大写为 Docker,即 Docker HubDocker镜像

Suggested change
我们在 docker hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members)目前docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。如果docker镜像有问题,可以联系他(邮箱: [email protected])。
我们在 Docker Hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members)目前Docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。如果Docker镜像有问题,可以联系他(邮箱: [email protected])。

@@ -1,56 +1,113 @@
---
sidebar_position: 8
sidebar_position: 2
Copy link
Member

Choose a reason for hiding this comment

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

我们有其他页面设置了 sidebar_position 2,所以如果一定要把 docker 放在第二个,其他文件的顺序也得改。

Copy link
Member Author

Choose a reason for hiding this comment

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

那改一下?你觉得docker放2合适吗

@Harry-Yu-Shuhang Harry-Yu-Shuhang marked this pull request as draft September 24, 2025 02:59
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.

2 participants