Skip to content

docs(en): add the Using WebUI section missing from the English quick start - #1008

Open
louisss1016 wants to merge 1 commit into
modelscope:mainfrom
louisss1016:docs/en-quickstart-webui
Open

louisss1016 wants to merge 1 commit into
modelscope:mainfrom
louisss1016:docs/en-quickstart-webui

Conversation

@louisss1016

Copy link
Copy Markdown

Description

The English and Chinese quick-start pages have drifted apart.

docs/en/GetStarted/Introduction.md and docs/zh/GetStarted/quick-start.md are the same page in two languages, but the English one stops after the CodeGenesis example list. The Chinese page continues with a 使用 WebUI section documenting the ms-agent ui entry point. English readers never see it.

This PR ports that section over, so both languages cover the same three entry points (Python API, CLI, WebUI).

Changes

One file, +14 lines, appended to docs/en/GetStarted/Introduction.md:

  • a ## Using WebUI section with the pip install -U "ms-agent[webui]" / ms-agent ui commands
  • the prerequisites the Chinese page states (Python 3.12+, Node.js 22.22.0+, pnpm 10.17.1)
  • the Settings → Model Settings step to configure a model service before creating a project and session

Two deliberate deviations from a literal translation:

  1. The link points at webui/README.md rather than webui/README_ZH.md, and uses the #first-time-setup anchor — the same target docs/en/GetStarted/Installation.md already links to, so the English pages stay consistent with each other.
  2. Wording follows the existing English page ("Developers can also refer to…", the bulleted example style) instead of mirroring the Chinese sentence order.

Verification

  • Diffed the two pages section by section; Using WebUI was the only section present in Chinese and absent in English. Installation, the Python example, and the CLI example already matched.
  • Checked that this repo does not extract fenced blocks as runnable tests: tests/ contains no example collector (no find_examples-style helper), and .github/workflows/ has no docs job — citest.yaml runs a single unittest job. The added ```shell block is not executed.
  • Format: no trailing whitespace, no smart quotes, file ends with a newline.

Notes

Not opening an issue first because this is a straight documentation-parity fix rather than a design question. Happy to split differently — for example, if the intent is for Introduction.md to stay a short overview and a separate QuickStart.md to carry the usage content, say so and I'll restructure instead.

…start

The English page (docs/en/GetStarted/Introduction.md) covers the Python and CLI
examples but stops before the WebUI section that docs/zh/GetStarted/quick-start.md
has, so English readers never see the ms-agent ui entry point. Port the section,
linking the English WebUI README instead of README_ZH.md, and use the
#first-time-setup anchor that docs/en/GetStarted/Installation.md already uses.

This branch has not been deployed

No deployments
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