Skip to content

chore: update describtion of front-end in readme#113

Merged
HsiangNianian merged 8 commits intoHydroRoll-Team:mainfrom
NtskwK:chore/readme
Feb 28, 2026
Merged

chore: update describtion of front-end in readme#113
HsiangNianian merged 8 commits intoHydroRoll-Team:mainfrom
NtskwK:chore/readme

Conversation

@NtskwK
Copy link
Member

@NtskwK NtskwK commented Feb 28, 2026

Summary by Sourcery

Update README documentation to reflect the current React-based frontend stack and simplify dependency installation steps.

Documentation:

  • Update English and Chinese READMEs to describe the frontend as built with React 19, Shadcn UI, and Tailwind CSS 4 instead of Svelte 5.
  • Simplify setup instructions in both READMEs by generalizing the dependency installation step without changing into a separate UI directory.

Copilot AI review requested due to automatic review settings February 28, 2026 01:11
@vercel
Copy link

vercel bot commented Feb 28, 2026

@NtskwK is attempting to deploy a commit to the retrofor Team on Vercel.

A member of the Team first needs to authorize it.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 28, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the English and Chinese READMEs to reflect the current React-based frontend stack and simplifies the dependency installation instructions to match the new project layout.

Flow diagram for updated dependency installation process in README

flowchart TD
  A[Start: Developer wants to run DropOut from source] --> B[Clone repository]
  B --> C[cd DropOut]
  C --> D[Install dependencies with pnpm install in project root]
  D --> E[Run development command as described in README]
  E --> F[DropOut runs in development mode]
  F --> G[End]
Loading

File-Level Changes

Change Details Files
Document the current frontend tech stack (React 19, Shadcn UI, Tailwind CSS 4) instead of the previous Svelte-based description.
  • Update Chinese README intro paragraph to describe the web UI as based on React 19, Shadcn UI, and Tailwind CSS 4.
  • Update Chinese README feature bullet for the modern industrial UI to list React 19, Shadcn UI, and Tailwind CSS 4.
  • Update English README intro paragraph to describe the web UI as built with React 19, Shadcn UI, and Tailwind CSS 4.
  • Update English README feature bullet for the modern industrial UI to list React 19, Shadcn UI, and Tailwind CSS 4 instead of Svelte 5.
README.CN.md
README.md
Simplify dependency installation instructions to reflect that pnpm install should be run at the repo root without cd into ui.
  • Rename the Chinese step title from installing frontend dependencies to installing dependencies and remove the cd ui / cd .. commands.
  • Rename the English step title from Install Frontend Dependencies to Install Dependencies and remove the cd ui / cd .. commands.
README.CN.md
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've found 4 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="README.CN.md" line_range="17" />
<code_context>
 它不仅仅是为了启动 Minecraft 而设计的,而是将 Minecraft 环境作为确定性的、版本化的工作空间进行管理。

-DropOut 使用 Tauri v2 构建,DropOut 提供原生性能和最小资源使用,并配有现代响应式 Web UI(目前使用 Svelte 5,正在迁移到 React)。
+DropOut 使用 Tauri v2 构建,DropOut 提供原生性能和最小资源使用,并配有现代响应式 Web UI(基于 React 19、Shadcn UI 和 Tailwind CSS 4 构建)。

 > Minecraft 环境是一个复杂的系统。
</code_context>
<issue_to_address>
**suggestion (typo):** Consider using the canonical project name spelling for shadcn/ui.

Using the "shadcn/ui" branding here will better match the project’s official name and make it easier for readers to recognize and search for it.

Suggested implementation:

```
DropOut 使用 Tauri v2 构建,DropOut 提供原生性能和最小资源使用,并配有现代响应式 Web UI(基于 React 19、shadcn/ui 和 Tailwind CSS 4 构建)。

```

```
- **现代工业 UI**:使用 **React 19**、**shadcn/ui** 和 **Tailwind CSS 4** 设计的干净、无干扰界面。

```
</issue_to_address>

### Comment 2
<location path="README.CN.md" line_range="45" />
<code_context>

 - **高性能**:使用 Rust 和 Tauri 构建,实现最小资源使用和快速启动时间。
-- **现代工业 UI**:使用 **Svelte 5****Tailwind CSS 4** 设计的干净、无干扰界面。
+- **现代工业 UI**:使用 **React 19****Shadcn UI****Tailwind CSS 4** 设计的干净、无干扰界面。
 - **Microsoft 认证**:通过官方 Xbox Live 和 Microsoft OAuth 流程(设备代码流程)提供安全登录支持。
 - **模组加载器支持**:
</code_context>
<issue_to_address>
**suggestion (typo):** Align the library name here with the canonical "shadcn/ui" spelling.

This keeps the docs consistent with the library’s official naming and any other references in the project.

Suggested implementation:

```
DropOut 使用 Tauri v2 构建,DropOut 提供原生性能和最小资源使用,并配有现代响应式 Web UI(基于 React 19、shadcn/ui 和 Tailwind CSS 4 构建)。

```

```
- **现代工业 UI**:使用 **React 19**、**shadcn/ui** 和 **Tailwind CSS 4** 设计的干净、无干扰界面。

```
</issue_to_address>

### Comment 3
<location path="README.md" line_range="17" />
<code_context>
 It is designed not just to launch Minecraft, but to manage Minecraft environments as deterministic, versioned workspaces.

-Built with Tauri v2 and Rust, DropOut delivers native performance and minimal resource usage, paired with a modern reactive web UI (currently Svelte 5, migrating to React).
+Built with Tauri v2 and Rust, DropOut delivers native performance and minimal resource usage, paired with a modern reactive web UI built with React 19, Shadcn UI, and Tailwind CSS 4.

 > Minecraft environments are complex systems.
</code_context>
<issue_to_address>
**suggestion (typo):** Use the official "shadcn/ui" naming for clarity and consistency.

Please change "Shadcn UI" to "shadcn/ui" to match the official project name and make it easier for users to recognize and look up.

Suggested implementation:

```
Built with Tauri v2 and Rust, DropOut delivers native performance and minimal resource usage, paired with a modern reactive web UI built with React 19, shadcn/ui, and Tailwind CSS 4.

```

```
- **Modern Industrial UI**: A clean, distraction-free interface designed with **React 19**, **shadcn/ui**, and **Tailwind CSS 4**.

```
</issue_to_address>

### Comment 4
<location path="README.md" line_range="45" />
<code_context>

 - **High Performance**: Built with Rust and Tauri for minimal resource usage and fast startup times.
-- **Modern Industrial UI**: A clean, distraction-free interface designed with **Svelte 5** and **Tailwind CSS 4**.
+- **Modern Industrial UI**: A clean, distraction-free interface designed with **React 19**, **Shadcn UI**, and **Tailwind CSS 4**.
 - **Microsoft Authentication**: Secure login support via official Xbox Live & Microsoft OAuth flows (Device Code Flow).
 - **Mod Loader Support**:
</code_context>
<issue_to_address>
**suggestion (typo):** Consider using the canonical "shadcn/ui" naming here as well.

This will keep terminology consistent with the rest of the project and with the library’s own documentation.

Suggested implementation:

```
Built with Tauri v2 and Rust, DropOut delivers native performance and minimal resource usage, paired with a modern reactive web UI built with React 19, shadcn/ui, and Tailwind CSS 4.

```

```
- **Modern Industrial UI**: A clean, distraction-free interface designed with **React 19**, **shadcn/ui**, and **Tailwind CSS 4**.

```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the project documentation to reflect the current frontend stack and simplifies the build instructions to match the pnpm workspace setup.

Changes:

  • Update README/README.CN to describe the UI as React 19 + Shadcn UI + Tailwind CSS 4 (instead of Svelte/migration wording).
  • Adjust “Building from Source” steps to use pnpm install from the repository root (workspace install).

Reviewed changes

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

File Description
README.md Updates frontend tech stack description and build steps to match the pnpm workspace flow.
README.CN.md Mirrors the frontend description/build-step updates for the Chinese README.

@HsiangNianian HsiangNianian self-assigned this Feb 28, 2026
@HsiangNianian HsiangNianian added the documentation Improvements or additions to documentation label Feb 28, 2026
@HsiangNianian HsiangNianian merged commit 8217588 into HydroRoll-Team:main Feb 28, 2026
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants