Repository navigation
docs(en): add the Using WebUI section missing from the English quick start - #1008
Open
louisss1016 wants to merge 1 commit into
Open
louisss1016 wants to merge 1 commit into
louisss1016 wants to merge 1 commit into
Conversation
…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
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
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
The English and Chinese quick-start pages have drifted apart.
docs/en/GetStarted/Introduction.mdanddocs/zh/GetStarted/quick-start.mdare 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 thems-agent uientry 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:## Using WebUIsection with thepip install -U "ms-agent[webui]"/ms-agent uicommandsTwo deliberate deviations from a literal translation:
webui/README.mdrather thanwebui/README_ZH.md, and uses the#first-time-setupanchor — the same targetdocs/en/GetStarted/Installation.mdalready links to, so the English pages stay consistent with each other.Verification
Using WebUIwas the only section present in Chinese and absent in English.Installation, the Python example, and the CLI example already matched.tests/contains no example collector (nofind_examples-style helper), and.github/workflows/has no docs job —citest.yamlruns a singleunittestjob. The added ```shell block is not executed.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.mdto stay a short overview and a separateQuickStart.mdto carry the usage content, say so and I'll restructure instead.