Skip to content

Commit 8378dae

Browse files
authored
docs(core): docs for 1.0 (#1423)
* docs(core): add docs for system buttons * docs(core): merge mcp docs * docs(core): update toc * docs(core): update docs for cli * docs(core): update docs * docs(core): add docs * docs(core): fix all dead links * chore(core): merge latest code
1 parent 03485d6 commit 8378dae

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+1889
-2133
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ To change the AI-related code of this repository, you need to create a '.env 'fi
121121

122122
```
123123
OPENAI_API_KEY="your_token"
124-
MIDSCENE_MODEL_NAME="gpt-4o-2024-08-06"
124+
MIDSCENE_MODEL_NAME="qwen3-vl-plus"
125125
```
126126

127127

apps/site/docs-migration-log.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# 文档迁移工作日志
2+
3+
## 记录规范
4+
5+
- 每条记录都仅针对一个 breaking change,避免多个操作混写。
6+
- 在描述路径时请写明仓库内的完整相对路径,便于检索。
7+
- 如果是合并、拆分或改名,请在「操作类型」里明确指出。
8+
- 如果需要后续验证或修改,使用「后续行动」注明负责人或跟进人。
9+
10+
### 模板
11+
12+
```markdown
13+
### YYYY-MM-DD – 简短的变更摘要
14+
15+
- 原路径:`apps/site/...`
16+
- 原标题:`原文档标题`
17+
- 操作类型:移动 / 合并 / 拆分 / 重命名
18+
- 新位置:`apps/site/...`
19+
- Breaking change 说明:说明迁移原因、影响范围以及需要知悉的事项。
20+
- 后续行动:若无后续事项,可填「无」。
21+
```
22+
23+
## 迁移记录
24+
25+
(按时间倒序追加记录,最新记录放最上方)
26+
27+
### 2025-11-05 – 拆分英文 YAML 自动化与命令行文档
28+
29+
- 原路径:`apps/site/docs/en/automate-with-scripts-in-yaml.mdx`
30+
- 原标题:`Automate with scripts in YAML`
31+
- 操作类型:拆分
32+
- 新位置:`apps/site/docs/en/automate-with-scripts-in-yaml.mdx``apps/site/docs/en/command-line-tools.mdx`
33+
- Breaking change 说明:将 CLI 安装与执行说明抽离为独立页面,原文保留 YAML 格式与语法说明。同步更新 `apps/site/rspress.config.ts` 侧边栏链接为 `/command-line-tools`
34+
- 后续行动:无
35+
36+
### 2025-11-05 – 拆分中文 YAML 自动化与命令行文档
37+
38+
- 原路径:`apps/site/docs/zh/automate-with-scripts-in-yaml.mdx`
39+
- 原标题:`使用 YAML 格式的自动化脚本`
40+
- 操作类型:拆分
41+
- 新位置:`apps/site/docs/zh/automate-with-scripts-in-yaml.mdx``apps/site/docs/zh/command-line-tools.mdx`
42+
- Breaking change 说明:同步中文文档结构,新增命令行工具页面并简化 YAML 文档内容,同时更新侧边栏链接到 `/zh/command-line-tools`
43+
- 后续行动:无
44+
45+
### 2024-07-23 – 合并 Web 与 Android MCP 文档
46+
47+
- 原路径:`apps/site/docs/en/web-mcp.mdx`
48+
- 原标题:`MCP server`
49+
- 操作类型:合并
50+
- 新位置:`apps/site/docs/en/mcp.mdx`
51+
- Breaking change 说明:原 Web 端 MCP 文档与 Android MCP 文档合并为统一文档,新增对两种环境配置和工具差异的说明。
52+
- 后续行动:无
53+
54+
- 原路径:`apps/site/docs/en/mcp-android.mdx`
55+
- 原标题:`MCP server`
56+
- 操作类型:合并
57+
- 新位置:`apps/site/docs/en/mcp.mdx`
58+
- Breaking change 说明:Android 模式内容合入统一的 MCP 文档,文档中区分 Web 与 Android 的配置与可用工具。
59+
- 后续行动:无
60+
61+
- 原路径:`apps/site/docs/zh/web-mcp.mdx`
62+
- 原标题:`MCP 服务`
63+
- 操作类型:合并
64+
- 新位置:`apps/site/docs/zh/mcp.mdx`
65+
- Breaking change 说明:中文 Web 端 MCP 文档合并入统一文档,补充了 Web 与 Android 的环境差异说明。
66+
- 后续行动:无
67+
68+
- 原路径:`apps/site/docs/zh/mcp-android.mdx`
69+
- 原标题:`MCP 服务`
70+
- 操作类型:合并
71+
- 新位置:`apps/site/docs/zh/mcp.mdx`
72+
- Breaking change 说明:中文 Android 模式内容合并到统一 MCP 文档,统一呈现配置与工具差异。
73+
- 后续行动:无
74+
75+
### 2025-11-06 – 重命名桥接模式文档
76+
77+
- 原路径:`apps/site/docs/en/bridge-mode-by-chrome-extension.mdx``apps/site/docs/zh/bridge-mode-by-chrome-extension.mdx`
78+
- 原标题:`Bridge to the desktop Chrome``桥接到桌面 Chrome`
79+
- 操作类型:重命名
80+
- 新位置:`apps/site/docs/en/bridge-mode.mdx``apps/site/docs/zh/bridge-mode.mdx`
81+
- Breaking change 说明:将桥接模式文档从冗长的文件名简化为 `bridge-mode.mdx`,同时更新 `apps/site/rspress.config.ts` 中的侧边栏链接配置。
82+
- 后续行动:无
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Android Automation Support
2+
3+
Thanks to the visual model approach, Midscene can drive adb tools to support Android automation.
4+
5+
Since it adopts a visual model approach, apps built with any technology stack can integrate with Midscene. Developers can directly target the final results and debug their UI automation scripts.
6+
7+
The Android UI automation solution comes with all the features of Midscene:
8+
9+
- Supports zero-code trial using Playground.
10+
- Supports JavaScript SDK.
11+
- Supports automation scripts in YAML format and command-line tools.
12+
- Supports HTML reports to replay all operation paths.
13+
14+
## Showcases
15+
16+
### Navigate to Tourist Attraction
17+
18+
Open the Maps app, search for the destination, and start navigation.
19+
20+
<video src="https://lf3-static.bytednsdoc.com/obj/eden-cn/nupipfups/Midscene/android-maps.mp4" controls/>
21+
22+
### Auto-like on Twitter
23+
24+
Open Twitter and auto-like the first tweet by [@midscene_ai](https://x.com/midscene_ai).
25+
26+
<video src="https://lf3-static.bytednsdoc.com/obj/eden-cn/nupipfups/Midscene/android-twitter.mp4" controls/>
27+
28+
## Try with Playground
29+
30+
With Playground, you can experience Midscene's capabilities without writing any code.
31+
32+
Click here to view the [Android Playground usage documentation](/en/android-playground).
33+
34+
## Next Steps
35+
36+
* [Use JavaScript SDK](/en/integrate-with-android)
37+
* [Use YAML format automation scripts](/en/automate-with-scripts-in-yaml) and [command-line tools](/en/automate-with-scripts-in-yaml)
File renamed without changes.

apps/site/docs/en/api.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Each Agent in Midscene has its own constructor.
88

99
- In Puppeteer, use [PuppeteerAgent](./integrate-with-puppeteer)
10-
- In Bridge Mode, use [AgentOverChromeBridge](./bridge-mode-by-chrome-extension#constructor)
10+
- In Bridge Mode, use [AgentOverChromeBridge](./bridge-mode#constructor)
1111
- In Android, use [AndroidAgent](./integrate-with-android)
1212
- For GUI Agent integrating with your own interface, refer to [Integrate with any interface](./integrate-with-any-interface)
1313

@@ -1223,3 +1223,11 @@ describe('Android Settings Test', () => {
12231223
:::tip
12241224
The merged report file will be saved in the `midscene_run/report` directory by default. You can customize the report directory location by setting the `MIDSCENE_RUN_DIR` environment variable.
12251225
:::
1226+
1227+
## Platform-Specific Agents
1228+
1229+
- `AndroidAgent` / `AndroidDevice`: Use the Android SDK integration guide for APIs, constructors, and helper utilities. [Read more](./integrate-with-android#androidagent) and [device details](./integrate-with-android#androiddevice).
1230+
- `IOSAgent` / `IOSDevice`: Follow the iOS integration guide for WebDriverAgent-based automation. [Read more](./integrate-with-ios#iosagent) and [device details](./integrate-with-ios#iosdevice).
1231+
- `PuppeteerAgent`: See the Puppeteer integration doc for browser automation options and constructor parameters. [Read more](./integrate-with-puppeteer#puppeteeragent).
1232+
- `PlaywrightAgent`: Explore the Playwright integration guide for direct usage examples and configuration. [Read more](./integrate-with-playwright#playwrightagent).
1233+
- `AgentOverChromeBridge`: Refer to the bridge mode instructions for connecting local scripts to Chrome. [Read more](./bridge-mode#agentoverchromebridge).

0 commit comments

Comments
 (0)