Skip to content

docs: fix outdated port and startup command in QUICK_START.md, remove duplicate pipe in README#733

Open
sherrycs5210 wants to merge 1 commit into
hsliuping:mainfrom
sherrycs5210:fix/docs-outdated-port-and-typo
Open

docs: fix outdated port and startup command in QUICK_START.md, remove duplicate pipe in README#733
sherrycs5210 wants to merge 1 commit into
hsliuping:mainfrom
sherrycs5210:fix/docs-outdated-port-and-typo

Conversation

@sherrycs5210

Copy link
Copy Markdown

问题描述

文档中存在两处因技术栈迁移遗留的错误,可能导致新用户安装失败。

修改内容

README.md

  • 移除「中文增强特色」功能列表中多余的 | | 空元素(排版 typo)

docs/QUICK_START.md

  • 端口更新:将所有 localhost:8501(Streamlit 旧端口)更新为 localhost:3000(Vue 前端实际端口)
  • 启动命令更新:将已废弃的 python -m streamlit run web/app.py 替换为当前正确的启动脚本:
    • python scripts/startup/start_backend.py(后端)
    • python scripts/startup/start_web.py(前端)
  • FAQ 更新:端口检查项从 8501 更新为 3000/8000

原因

项目在 v1.0.0 已从 Streamlit 迁移至 FastAPI + Vue 3,但 QUICK_START.md 仍保留旧的 Streamlit 默认配置,会使新用户按文档操作后无法访问应用。

测试

改动均为文档修正,无需代码测试。端口信息已对照 docker-compose.yml(前端 3000、后端 8000)及 scripts/startup/ 目录核实。

- README.md: remove duplicate `|` in feature list (typo)
- QUICK_START.md: update localhost:8501 (Streamlit) → localhost:3000 (Vue frontend)
- QUICK_START.md: replace deprecated `streamlit run` command with
  current startup scripts (start_backend.py + start_web.py)
- QUICK_START.md: update FAQ port from 8501 to 3000/8000

The project migrated from Streamlit to FastAPI + Vue 3 in v1.0.0,
but QUICK_START.md still referenced the old Streamlit defaults.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
echopoison0712 pushed a commit to echopoison0712/TradingAgents-CN that referenced this pull request Jun 8, 2026
* docs: add Trendshift badge to localized readmes

* docs: add HelloGitHub badge beside Trendshift

* docs: switch HelloGitHub badge to neutral theme

* docs: move community badges below status badges
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.

1 participant