zoushiyang/page-agent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update the dev guide

Browse Source
This commit is contained in:
Simon
2026-04-15 17:05:09 +08:00
parent 8a75c15557
commit cc27ff9305
1 changed files with 18 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/developer-guide.md
View File

@@ -10,32 +10,37 @@ For contribution rules and expectations, see [../CONTRIBUTING.md](../CONTRIBUTIN
1. **Prerequisites** 1. **Prerequisites**
- `macOS` / `Linux` / `WSL` - `macOS` / `Linux` / `WSL`
- `node.js >= 24` with `npm >= 11` - `node.js ^22.13 || >=24` with `npm >= 11`
- An editor that supports `ts/eslint/prettier` - An editor that supports `ts/eslint/prettier`
- Make sure `eslint`, `prettier` and `commitlint` work well. Un-linted code won't pass the CI. - Make sure `eslint`, `prettier` and `commitlint` work well. Un-linted code won't pass the CI.
2. **Setup** 2. **Setup**
```bash ```bash
npm i npm i # Or `npm ci` if you don't want to change the lockfile
npm start # Start demo and documentation site npm start # Start website dev server
npm run build # Build libs and website npm run build # Build everything
``` ```
## 📦 Project Structure ## 📦 Project Structure
This is a **monorepo** with npm workspaces containing **4 main packages**: This is a **monorepo** with npm workspaces.
- **Page Agent** (`packages/page-agent/`) - Main entry with built-in UI Panel, published as `page-agent` on npm Published packages:
- **Page Agent** (`packages/page-agent/`) - Main entry with built-in UI Panel (npm: `page-agent`)
- **MCP** (`packages/mcp/`) - MCP server for browser control via Page Agent extension (npm: `@page-agent/mcp`)
- **Core** (`packages/core/`) - Core agent logic without UI (npm: `@page-agent/core`) - **Core** (`packages/core/`) - Core agent logic without UI (npm: `@page-agent/core`)
- **Extension** (`packages/extension/`) - Chrome extension for multi-page tasks and browser-level automation - **LLMs** (`packages/llms/`) - LLM client with reflection-before-action mental model
- **Website** (`packages/website/`) - React documentation and landing page. Also as demo and test page for the core lib. private package `@page-agent/website` - **Page Controller** (`packages/page-controller/`) - DOM operations and visual feedback, independent of LLM
- **UI** (`packages/ui/`) - Panel and i18n, decoupled from PageAgent
> We use a simplified monorepo solution with `native npm-workspace + ts reference + vite alias`. No fancy tooling. Hoisting is required. Applications:
>
> - When developing. Use alias so that we don't have to pre-build. - **Extension** (`packages/extension/`) - Browser extension (WXT + React)
> - When bundling. Use external and disable ts `paths` alias. - **Website** (`packages/website/`) - React docs, landing page, and dev playground (private)
> - When bundling `IIFE` and `Website`. Bundle everything together.
> Source-first monorepo with `npm workspaces + ts references + vite alias`. Library `package.json` exports point to `src/*.ts` during development, and point to `dist/*.js` when published. `workspaces` in root `package.json` must be in topological order.
## 🤖 AGENTS.md Alias ## 🤖 AGENTS.md Alias