Skip to content

Update README previews - #4

Merged
hiyouga merged 1 commit into
mainfrom
codex/add-minimal-web-slides
May 18, 2026
Merged

Update README previews#4
hiyouga merged 1 commit into
mainfrom
codex/add-minimal-web-slides

Conversation

@hiyouga

@hiyouga hiyouga commented May 18, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add the live demo link to the English README preview section
  • add Chinese README preview images and live demo link

Verification

  • npm run build

Copilot AI review requested due to automatic review settings May 18, 2026 06:39

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a live demo link to the English README preview section and brings the Chinese README to parity by adding a header image, preview section, live demo link, and preview screenshots.

Changes:

  • Add live demo URL to English README preview section
  • Add preview section with demo link and screenshots to Chinese README
  • Add header banner image to Chinese README

Reviewed changes

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

File Description
README.md Inserts a live demo link above the preview screenshots
README_ZH.md Adds header image and a new preview section with live demo link and screenshots

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gemini-code-assist gemini-code-assist Bot left a comment

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.

Code Review

This pull request updates the documentation by adding live demo links and preview images to both the English and Chinese README files. A review comment suggests an improvement for the Chinese README by using localized screenshots of the interface instead of reusing the English ones, which would better demonstrate the project's bilingual support.

Comment thread README_ZH.md
Comment on lines +13 to +15
![Minimal Web Slides 预览](https://github.com/user-attachments/assets/e500e1c7-b56f-438a-a16d-2a0f187f95fd)

![Minimal Web Slides 预览](https://github.com/user-attachments/assets/6c41ae5f-aa0c-4247-a40d-c2f7cf321176)

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 PR description mentions adding "Chinese README preview images", but the image URLs used here (and for the banner at line 5) are identical to those in the English README.md. Since this project highlights its bilingual support, it would be more effective to use screenshots showing the Chinese interface in this localized README to better demonstrate the feature to Chinese-speaking users.

@hiyouga
hiyouga merged commit 36d038b into main May 18, 2026
8 checks passed
@hiyouga
hiyouga deleted the codex/add-minimal-web-slides branch May 18, 2026 06:44
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