Skip to content

docs: hotfix webui doc#420

Merged
AgentScopeTeam merged 1 commit intoagentscope-ai:mainfrom
rayrayraykk:dev/0126/fix_doc
Jan 26, 2026
Merged

docs: hotfix webui doc#420
AgentScopeTeam merged 1 commit intoagentscope-ai:mainfrom
rayrayraykk:dev/0126/fix_doc

Conversation

@rayrayraykk
Copy link
Copy Markdown
Member

No description provided.

@rayrayraykk rayrayraykk requested review from a team and Copilot January 26, 2026 02:30
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @rayrayraykk, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the clarity and accuracy of the WebUI documentation. It reorders the presentation of different methods for interacting with Agents via the WebUI and refines the prerequisites for one of these methods, ensuring users have more precise instructions for setup and usage.

Highlights

  • Documentation Structure Update: The order of methods for calling an Agent in the WebUI documentation has been adjusted to better reflect the recommended workflow, moving the 'Start the Agent in Python and enable the WebUI' method to an earlier position.
  • Clarity in Prerequisites: The description for starting an Agent directly in Python with WebUI enabled has been refined to explicitly mention the configuration of the 'environment and API key' instead of 'model environment', providing clearer guidance to users.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@AgentScopeTeam AgentScopeTeam merged commit 034c234 into agentscope-ai:main Jan 26, 2026
11 checks passed
Copy link
Copy Markdown

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

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 WebUI documentation in both English and Chinese to include a new method for starting an agent. The changes are mostly good, but there are a couple of minor inconsistencies. In both documents, the introductory sentence still mentions 'three ways' to call an agent, but the list now contains four. Additionally, there's a minor grammatical point in the Chinese document that could be improved for clarity. I've left specific comments with suggestions for these points.

Comment thread cookbook/en/webui.md
Comment thread cookbook/zh/webui.md
Comment thread cookbook/zh/webui.md
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR is a documentation hotfix that updates the WebUI documentation in both English and Chinese versions. The main purpose is to add a new method for starting the Agent and reorder the existing methods.

Changes:

  • Added a new Method 2 for starting the Agent directly in Python with WebUI enabled
  • Renumbered the existing methods (old Method 2 becomes Method 3, old Method 3 becomes Method 4)
  • Simplified the description text for Method 2 to be more concise

Reviewed changes

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

File Description
cookbook/zh/webui.md Updated method list to include 4 methods instead of 3, added new Method 2, and simplified description text
cookbook/en/webui.md Updated method list to include 4 methods instead of 3, added new Method 2, and simplified description text

Comment thread cookbook/zh/webui.md
Comment thread cookbook/en/webui.md
Comment thread cookbook/zh/webui.md
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.

3 participants