docs: Add Web interface usage guide to README#20
Open
jsoncm wants to merge 1 commit intowhillhill:mainfrom
Open
docs: Add Web interface usage guide to README#20jsoncm wants to merge 1 commit intowhillhill:mainfrom
jsoncm wants to merge 1 commit intowhillhill:mainfrom
Conversation
- Add comprehensive Web interface section in all README files (EN/ZH/main) - Include Docker deployment instructions (recommended method) - Add local development mode setup guide - Document production deployment steps - Fixes whillhill#11
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Description
This PR adds comprehensive documentation for the Web interface usage to address issue #11.
🔍 Problem
Users were confused about how to access and use the Web interface locally. The README only mentioned the online demo link but didn't explain how to run the Web UI locally.
✨ Changes
Added a new "Web Interface" section to all README files (main, Chinese, and English versions) that includes:
Docker deployment (recommended method)
start-all.shscriptLocal development mode
Production deployment
Online demo reference
🎯 Fixes
Closes #11
📸 Documentation Structure
The new section is placed after the "API Mode" section and before "Docker Deployment", providing a logical flow from API setup to Web interface usage.
✅ Checklist