From 3df71788ffd8370d0c1c2d8f48c278c570d60ff6 Mon Sep 17 00:00:00 2001 From: Simon <10131203+gaomeng1900@users.noreply.github.com> Date: Mon, 19 Jan 2026 20:14:40 +0800 Subject: [PATCH] docs: update package descriptions --- AGENTS.md | 36 ++++++++++++++++++------------------ README-zh.md | 4 ++-- README.md | 4 ++-- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 4fca589..f4a0b94 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -31,8 +31,8 @@ Simple monorepo solution: TypeScript references + Vite aliases. Update tsconfig ``` packages/ -├── page-agent/ # npm: "page-agent" ⭐ MAIN (with Panel UI + IIFE builds) -├── core/ # npm: "@page-agent/core" (headless, no UI) +├── core/ # npm: "@page-agent/core" ⭐ Core agent logic (headless) +├── page-agent/ # npm: "page-agent" entry class (with UI + controller + demo builds) ├── website/ # @page-agent/website (private) ├── llms/ # @page-agent/llms ├── page-controller/ # @page-agent/page-controller @@ -89,28 +89,28 @@ Build with `npm run build:iife --workspace=page-agent`. ### Page Agent (`packages/page-agent/`) -| File | Description | -| ----------------------- | -------------------------------------------- | -| `src/PageAgent.ts` | ⭐ Main class with UI, extends PageAgentCore | -| `src/entry-iife.ts` | IIFE entry (exposes PageAgent class) | -| `src/entry-iife-demo.ts`| IIFE demo entry (auto-init with demo API) | +| File | Description | +| ------------------------ | -------------------------------------------- | +| `src/PageAgent.ts` | ⭐ Main class with UI, extends PageAgentCore | +| `src/entry-iife.ts` | IIFE entry (exposes PageAgent class) | +| `src/entry-iife-demo.ts` | IIFE demo entry (auto-init with demo API) | ### Core (`packages/core/`) -| File | Description | -| ----------------------- | ------------------------------------------- | -| `src/PageAgentCore.ts` | ⭐ Core agent class without UI | -| `src/tools/` | Tool definitions calling PageController | -| `src/config/` | Configuration types and constants | -| `src/prompts/` | System prompt templates | +| File | Description | +| ---------------------- | --------------------------------------- | +| `src/PageAgentCore.ts` | ⭐ Core agent class without UI | +| `src/tools/` | Tool definitions calling PageController | +| `src/config/` | Configuration types and constants | +| `src/prompts/` | System prompt templates | ### LLMs (`packages/llms/`) -| File | Description | -| ---------------------------- | ------------------------------------- | -| `src/index.ts` | ⭐ LLM class with retry logic | -| `src/types.ts` | MacroToolInput, AgentBrain, LLMConfig | -| `src/OpenAILenientClient.ts` | OpenAI-compatible client | +| File | Description | +| --------------------- | ------------------------------------- | +| `src/index.ts` | ⭐ LLM class with retry logic | +| `src/types.ts` | MacroToolInput, AgentBrain, LLMConfig | +| `src/OpenAIClient.ts` | OpenAI-compatible client | ### Page Controller (`packages/page-controller/`) diff --git a/README-zh.md b/README-zh.md index 63c2f5f..6e6e49b 100644 --- a/README-zh.md +++ b/README-zh.md @@ -76,8 +76,8 @@ PageAgent adopts a simplified monorepo structure: ``` packages/ -├── page-agent/ # AI agent and demo(npm: page-agent) -├── core/ # Agent core logic without UI(npm: @page-agent/core) +├── core/ # ** Core agent logic without UI(npm: @page-agent/core) ** +├── page-agent/ # Exported agent and demo(npm: page-agent) ├── llms/ # LLM 客户端 (npm: @page-agent/llms) ├── page-controller/ # DOM 操作 & 蒙层 & 模拟鼠标 (npm: @page-agent/page-controller) ├── ui/ # 面板 & i18n (npm: @page-agent/ui) diff --git a/README.md b/README.md index 699f1e1..972414b 100644 --- a/README.md +++ b/README.md @@ -74,8 +74,8 @@ PageAgent adopts a simplified monorepo structure: ``` packages/ -├── page-agent/ # AI agent and demo(npm: page-agent) -├── core/ # Agent core logic without UI(npm: @page-agent/core) +├── core/ # ** Core agent logic without UI(npm: @page-agent/core) ** +├── page-agent/ # Exported agent and demo(npm: page-agent) ├── llms/ # LLM client (npm: @page-agent/llms) ├── page-controller/ # DOM operations & Visual Mask (npm: @page-agent/page-controller) ├── ui/ # Panel & i18n (npm: @page-agent/ui)