From 3762d0f1e0bbf48cfed3dd41fec0ad33cdaed9cb Mon Sep 17 00:00:00 2001
From: Simon <10131203+gaomeng1900@users.noreply.github.com>
Date: Sat, 17 Jan 2026 14:59:09 +0800
Subject: [PATCH] chore: refine docs
---
README-zh.md | 69 +++++++------------
README.md | 69 +++++++------------
.../pages/docs/introduction/overview/page.tsx | 7 --
3 files changed, 48 insertions(+), 97 deletions(-)
diff --git a/README-zh.md b/README-zh.md
index a93ba3c..fe4f74c 100644
--- a/README-zh.md
+++ b/README-zh.md
@@ -2,7 +2,7 @@
-[](https://badge.fury.io/js/page-agent) [](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [](https://www.npmjs.com/package/page-agent) [](https://bundlephobia.com/package/page-agent) [](https://github.com/alibaba/page-agent)
+[](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [](https://www.npmjs.com/package/page-agent) [](https://bundlephobia.com/package/page-agent) [](https://github.com/alibaba/page-agent)
纯 JS 实现的 GUI agent。使用自然语言操作你的 Web 应用。无须后端、客户端、浏览器插件。
@@ -10,7 +10,7 @@
👉 🚀 Demo | 📖 Documentation
-
+
---
@@ -28,22 +28,25 @@
## 🚀 快速开始
-### 快速体验 (Demo CDN)
+### 快速体验 (With Testing LLM)
最快的体验方式：
```html
-
+
```
> ⚠️ **仅用于技术评估。** Demo 模型有速率限制和使用限制，生产环境请使用 NPM 方式。
-| 位置 | URL |
-| ------ | --------------------------------------------------------------------------------------- |
-| 全球 | https://cdn.jsdelivr.net/npm/@page-agent/cdn/dist/page-agent.demo.js |
-| 中国 | https://registry.npmmirror.com/@page-agent/cdn/latest/files/dist/page-agent.demo.js |
+| Mirrors | URL |
+| ------- | ----------------------------------------------------------------------------------- |
+| Global | https://cdn.jsdelivr.net/npm/@page-agent/cdn/dist/page-agent.demo.js |
+| China | https://registry.npmmirror.com/@page-agent/cdn/latest/files/dist/page-agent.demo.js |
-### NPM 安装（推荐）
+### NPM 安装
```bash
npm install page-agent
@@ -62,26 +65,7 @@ const agent = new PageAgent({
await agent.execute('点击登录按钮')
```
-### CDN 引入
-
-适用于无法使用 NPM 的环境，用法与 NPM 一致：
-
-```html
-
-
-```
-
-| 位置 | URL |
-| ------ | ----------------------------------------------------------------------------------- |
-| 全球 | https://cdn.jsdelivr.net/npm/@page-agent/cdn/dist/page-agent.js |
-| 中国 | https://registry.npmmirror.com/@page-agent/cdn/latest/files/dist/page-agent.js |
+适用于无法使用 NPM 的环境，我们也提供了 IIFE 构建的 CDN 方式。[@see CDN Usage](https://alibaba.github.io/page-agent/#/docs/integration/cdn-setup)
## 🏗️ 架构设计
@@ -101,28 +85,19 @@ packages/
欢迎社区贡献！以下是参与方式：
-### 开发环境
+1. Fork 并 clone。`git clone https://github.com/alibaba/page-agent.git && cd page-agent`
+2. 安装依赖: `npm install`
+3. 启动开发: `npm start`
-1. Fork 项目仓库
-2. Clone or fork: `git clone https://github.com/alibaba/page-agent.git && cd page-agent`
-3. 安装依赖: `npm install`
-4. 启动开发: `npm start`
+更多详情请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。
-### 贡献指南
-
-请在贡献前阅读我们的[行为准则](CODE_OF_CONDUCT.md)和[贡献指南](CONTRIBUTING.md)。
+请在贡献前阅读我们的[行为准则](CODE_OF_CONDUCT.md)。
## 👏 致谢
-本项目基于以下优秀项目构建：
+本项目基于 **[`browser-use`](https://github.com/browser-use/browser-use)** 的优秀工作构建。
-- **[browser-use](https://github.com/browser-use/browser-use)**
-
-PageAgent 专为**客户端网页增强**设计，不是服务端自动化工具。
-
-## 📄 许可证
-
-MIT 许可证 - 详见 [LICENSE](LICENSE) 文件。
+`PageAgent` 专为**客户端网页增强**设计，不是服务端自动化工具。
```
DOM processing components and prompt are derived from browser-use:
@@ -141,6 +116,10 @@ Third-party dependencies and their licenses can be found in the package.json
file and in the node_modules directory after installation.
```
+## 📄 许可证
+
+[MIT License](LICENSE)
+
---
**⭐ 如果觉得 PageAgent 有用或有趣，请给项目点个星！**
diff --git a/README.md b/README.md
index 272a81d..27e6667 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
-[](https://badge.fury.io/js/page-agent) [](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [](https://www.npmjs.com/package/page-agent) [](https://bundlephobia.com/package/page-agent) [](https://github.com/alibaba/page-agent)
+[](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [](https://www.npmjs.com/package/page-agent) [](https://bundlephobia.com/package/page-agent) [](https://github.com/alibaba/page-agent)
The GUI Agent Living in Your Webpage. Control web interfaces with natural language.
@@ -10,7 +10,7 @@ The GUI Agent Living in Your Webpage. Control web interfaces with natural langua
👉 🚀 Demo | 📖 Documentation
-
+
---
@@ -28,22 +28,25 @@ The GUI Agent Living in Your Webpage. Control web interfaces with natural langua
## 🚀 Quick Start
-### Quick Try (Demo CDN)
+### Quick Try (With Testing LLM)
Fastest way to try PageAgent:
```html
-
+
```
> ⚠️ **For technical evaluation only.** Demo model has rate limits and usage restrictions. Use NPM for production.
-| Location | URL |
-| -------- | --------------------------------------------------------------------------------------- |
-| Global | https://cdn.jsdelivr.net/npm/@page-agent/cdn/dist/page-agent.demo.js |
-| China | https://registry.npmmirror.com/@page-agent/cdn/latest/files/dist/page-agent.demo.js |
+| Mirrors | URL |
+| ------- | ----------------------------------------------------------------------------------- |
+| Global | https://cdn.jsdelivr.net/npm/@page-agent/cdn/dist/page-agent.demo.js |
+| China | https://registry.npmmirror.com/@page-agent/cdn/latest/files/dist/page-agent.demo.js |
-### NPM Installation (Recommended)
+### NPM Installation
```bash
npm install page-agent
@@ -62,26 +65,7 @@ const agent = new PageAgent({
await agent.execute('Click the login button')
```
-### CDN Build
-
-For environments where NPM is not available. Usage is identical to NPM:
-
-```html
-
-
-```
-
-| Location | URL |
-| -------- | ----------------------------------------------------------------------------------- |
-| Global | https://cdn.jsdelivr.net/npm/@page-agent/cdn/dist/page-agent.js |
-| China | https://registry.npmmirror.com/@page-agent/cdn/latest/files/dist/page-agent.js |
+For environments where NPM is not available. We do offer a IIFE build via CDN. [@see CDN Usage](https://alibaba.github.io/page-agent/#/docs/integration/cdn-setup)
## 🏗️ Structure
@@ -101,28 +85,19 @@ packages/
We welcome contributions from the community! Here's how to get started:
-### Setup
+1. Fork and clone. `git clone https://github.com/alibaba/page-agent.git && cd page-agent`
+2. Install dependencies: `npm install`
+3. Start development: `npm start`
-1. Fork the repository
-2. Clone your fork: `git clone https://github.com/alibaba/page-agent.git && cd page-agent`
-3. Install dependencies: `npm install`
-4. Start development: `npm start`
+More details in [CONTRIBUTING.md](CONTRIBUTING.md).
-### Contributing Guidelines
-
-Please read our [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing Guide](CONTRIBUTING.md) before contributing.
+Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
## 👏 Acknowledgments
-This project builds upon the excellent work of:
+This project builds upon the excellent work of **[`browser-use`](https://github.com/browser-use/browser-use)**.
-- **[browser-use](https://github.com/browser-use/browser-use)**
-
-PageAgent is designed for **client-side web enhancement**, not server-side automation.
-
-## 📄 License
-
-MIT License - see the [LICENSE](LICENSE) file for details.
+`PageAgent` is designed for **client-side web enhancement**, not server-side automation.
```
DOM processing components and prompt are derived from browser-use:
@@ -141,6 +116,10 @@ Third-party dependencies and their licenses can be found in the package.json
file and in the node_modules directory after installation.
```
+## 📄 License
+
+[MIT License](LICENSE)
+
---
**⭐ Star this repo if you find PageAgent helpful!**
diff --git a/packages/website/src/pages/docs/introduction/overview/page.tsx b/packages/website/src/pages/docs/introduction/overview/page.tsx
index c509ad7..d5ae1d2 100644
--- a/packages/website/src/pages/docs/introduction/overview/page.tsx
+++ b/packages/website/src/pages/docs/introduction/overview/page.tsx
@@ -22,13 +22,6 @@ export default function Overview() {
{/* Status Badges */}
-
