docs: archive legacy planning and frontend assets

This commit is contained in:
zyl
2026-03-26 19:30:07 +08:00
parent b90955d1b5
commit 11c0b0fc70
25 changed files with 68 additions and 29 deletions

View File

@@ -1,17 +1,17 @@
# Repository Guidelines # Repository Guidelines
## Project Structure & Module Organization ## Project Structure & Module Organization
`docs/` is the main source of product, architecture, integration, and team-process documentation. Keep active engineering documents in `docs/*.md`; presentation exports belong under `docs/archive/领导演示资料/`. `frontend/sgClaw验证/` contains the only active runnable UI: a Vue 2 verification page (`index.html`, `index.vue`) plus helper scripts (`serve.sh`, `download-libs.sh`, `testRunner.js`). `frontend/README.md` and `docs/README.md` describe what is active versus archived. `docs/` is the main source of product, architecture, integration, and team-process documentation. Keep active engineering documents in `docs/*.md`; presentation exports belong under `docs/archive/领导演示资料/`. `frontend/archive/sgClaw验证-已归档/` contains the historical Vue 2 verification page (`index.html`, `index.vue`) plus helper scripts (`serve.sh`, `download-libs.sh`, `testRunner.js`). `frontend/README.md` and `docs/README.md` describe what is active versus archived.
## Build, Test, and Development Commands ## Build, Test, and Development Commands
There is no formal build system in the repository today. Use the local verification page directly: There is no formal build system in the repository today. Use the local verification page directly:
- `bash frontend/sgClaw验证/serve.sh` - `bash frontend/archive/sgClaw验证-已归档/serve.sh`
Starts a local HTTP server on port `8080` by default. Starts a local HTTP server on port `8080` by default.
- `bash frontend/sgClaw验证/serve.sh 9090` - `bash frontend/archive/sgClaw验证-已归档/serve.sh 9090`
Serves the verification page on a custom port. Serves the verification page on a custom port.
- `bash frontend/sgClaw验证/download-libs.sh` - `bash frontend/archive/sgClaw验证-已归档/download-libs.sh`
Downloads Vue 2.6.14 and Element UI assets into `frontend/sgClaw验证/lib/` for offline use. Downloads Vue 2.6.14 and Element UI assets into `frontend/archive/sgClaw验证-已归档/lib/` for offline use.
Open `http://localhost:8080/index.html` after starting the server. Open `http://localhost:8080/index.html` after starting the server.
@@ -19,10 +19,10 @@ Open `http://localhost:8080/index.html` after starting the server.
Match the existing style in each file. Frontend code uses 2-space indentation, semicolon-free JavaScript, and simple Vue 2 patterns. Shell scripts should stay Bash-compatible, include `set -e`, and keep usage notes at the top. Preserve existing Chinese file names and domain terminology; add new docs with concise, descriptive names such as `L5-xxx.md` or `xxx_printable.md` when extending the documentation set. Match the existing style in each file. Frontend code uses 2-space indentation, semicolon-free JavaScript, and simple Vue 2 patterns. Shell scripts should stay Bash-compatible, include `set -e`, and keep usage notes at the top. Preserve existing Chinese file names and domain terminology; add new docs with concise, descriptive names such as `L5-xxx.md` or `xxx_printable.md` when extending the documentation set.
## Testing Guidelines ## Testing Guidelines
Testing is currently manual and centered on `frontend/sgClaw验证/testRunner.js`. Validate changes by serving the page, running the relevant verification flows, and recording whether the change affects external API checks, internal browser integration checks, or end-to-end scenarios. If a change touches archived presentation assets, verify links and exported files still open correctly. Testing is currently manual and centered on `frontend/archive/sgClaw验证-已归档/testRunner.js`. Validate changes by serving the page, running the relevant verification flows, and recording whether the change affects external API checks, internal browser integration checks, or end-to-end scenarios. If a change touches archived presentation assets, verify links and exported files still open correctly.
## Commit & Pull Request Guidelines ## Commit & Pull Request Guidelines
Git history currently contains only `first commit`, so no strong convention is established yet. Use short imperative commit subjects, for example `docs: update browser integration notes` or `frontend: adjust verification report layout`. PRs should include a clear summary, affected paths, manual validation steps, and screenshots when `frontend/sgClaw验证/` UI output changes. Link related docs or issues when the change updates architecture or process guidance. Git history currently contains only `first commit`, so no strong convention is established yet. Use short imperative commit subjects, for example `docs: update browser integration notes` or `frontend: adjust verification report layout`. PRs should include a clear summary, affected paths, manual validation steps, and screenshots when `frontend/archive/sgClaw验证-已归档/` UI output changes. Link related docs or issues when the change updates architecture or process guidance.
## Security & Configuration Tips ## Security & Configuration Tips
Do not commit real API keys. The verification page expects runtime globals such as `window.__SGCLAW_TEST_OPENAI_KEY__` and `window.__SGCLAW_TEST_CLAUDE_KEY__`; keep them in local test-only setup, not tracked files. Do not commit real API keys. The verification page expects runtime globals such as `window.__SGCLAW_TEST_OPENAI_KEY__` and `window.__SGCLAW_TEST_CLAUDE_KEY__`; keep them in local test-only setup, not tracked files.

View File

@@ -7,8 +7,8 @@ sgClaw 项目仓库。
- `src/`Rust 侧最小 Agent 实现,包含 pipe 协议、握手、`BrowserPipeTool`、规则规划器、DeepSeek provider、最小 Agent runtime。 - `src/`Rust 侧最小 Agent 实现,包含 pipe 协议、握手、`BrowserPipeTool`、规则规划器、DeepSeek provider、最小 Agent runtime。
- `tests/`协议、握手、工具、规划器、runtime 与 JSON Line 联调测试。 - `tests/`协议、握手、工具、规划器、runtime 与 JSON Line 联调测试。
- `resources/rules.json`:本地安全策略白名单。 - `resources/rules.json`:本地安全策略白名单。
- `docs/`项目架构、联调协议与团队启动文档 - `docs/`产品主线文档(架构、实现、交付、接口)与归档入口
- `frontend/sgClaw验证/`:本地验证页面与辅助脚本。 - `frontend/archive/sgClaw验证-已归档/`历史本地验证页面与脚本(归档,仅做参考)
## 常用命令 ## 常用命令
@@ -19,7 +19,7 @@ cargo test --test agent_runtime_test -q
node --test tools/browser_smoke/fake_deepseek_server.test.mjs node --test tools/browser_smoke/fake_deepseek_server.test.mjs
node tools/browser_smoke/run_deepseek_browser_smoke.mjs node tools/browser_smoke/run_deepseek_browser_smoke.mjs
cargo run cargo run
bash frontend/sgClaw验证/serve.sh bash frontend/archive/sgClaw验证-已归档/serve.sh
``` ```
## 浏览器侧 DeepSeek smoke ## 浏览器侧 DeepSeek smoke

View File

@@ -1,22 +1,38 @@
# docs 目录说明 # docs 目录说明
## 当前有效文档(研发与管理 ## 产品文档(核心
- `团队管理标准.md`:团队管理制度、角色清单、变更流程 - `L0-产品白皮书与能力全景层.md`:能力边界与目标价值
- `浏览器对接标准.md`Chromium ↔ sgClaw 联调接口标准P1a/P2 必读) - `L1-系统架构与安全模型层.md`:架构分层与安全决策
- `L0-产品白皮书与能力全景层.md` ~ `L4-工程实现与部署拓扑层.md`:架构分层文档 - `L2-核心模块与接口契约层.md`:模块边界、接口设计与数据结构
- `团队分工.md``协作时间表.md``协作甘特图.md`:协作计划源文档 - `L3-数据流与Skill体系层.md`执行流程、Skill 语义与数据协议
- `L5-提示词分布与安全改造方案.md`:提示词注入来源与调用时机、安全加固优先级建议 - `L4-工程实现与部署拓扑层.md`:仓库结构、构建、集成和部署
- `L5-提示词分布与安全改造方案.md`:提示词治理与风控增强策略。
- `浏览器对接标准.md`Rust 与 Chromium 对接的协议基线。
## 归档文档(领导演示素材) ## 归档文档
为避免研发目录混杂演示资产,以下内容已统一归档到: ### 项目管理与排期(已归档)
- `archive/领导演示资料/docs-html/`:演示网页(架构图、时间表) 以下文档已移入 `archive/项目管理与排期/`,保留历史参考,不作为产品主线阅读入口:
- `archive/领导演示资料/docs-pdf/`:演示导出的 PDF
- `archive/领导演示资料/docs-figures/`演示图SVG
- `archive/领导演示资料/docs-scripts/`:演示查看/导出脚本
- `archive/领导演示资料/frontend-pages/`:前端演示网页
- `archive/领导演示资料/frontend-svgs/`:前端演示图源文件
> 归档原则:不影响研发主线文档,演示资产可追溯、可复用、可批量查找。 - `archive/项目管理与排期/团队分工.md`
- `archive/项目管理与排期/团队管理标准.md`
- `archive/项目管理与排期/协作时间表.md`
- `archive/项目管理与排期/协作甘特图.md`
- `archive/项目管理与排期/协作时间表_printable.md`
- `archive/项目管理与排期/协作甘特图_printable.md`
- `archive/项目管理与排期/sgclaw_project_team_kickoff.md`
- `archive/项目管理与排期/browser_team_kickoff.md`
- `archive/项目管理与排期/团队管理标准.pdf`
### 领导演示与导出资产
- `archive/领导演示资料/docs-html/`
- `archive/领导演示资料/docs-pdf/`
- `archive/领导演示资料/docs-figures/`
- `archive/领导演示资料/docs-scripts/`
- `archive/领导演示资料/frontend-pages/`
- `archive/领导演示资料/frontend-svgs/`
> 归档原则:产品主线文档与交付实现说明保持在 `docs/` 根目录;管理类资料与演示资料集中归档便于追溯。

View File

@@ -0,0 +1,10 @@
# 项目管理与排期归档
本目录存放团队协作与管理向文档,作为历史参考:
- 团队分工与职责
- 管理标准与流程规范
- 协作时间表与甘特图
- 启动说明文档Rust 侧 / 浏览器侧)
这些文档不再作为产品主线文档入口的一部分。

View File

@@ -301,7 +301,7 @@ Expected: PASS including provider and runtime suites.
- Modify: `README.md` - Modify: `README.md`
- Create: `docs/superpowers/acceptance/2026-03-25-superrpa-sgclaw-browser-control.md` - Create: `docs/superpowers/acceptance/2026-03-25-superrpa-sgclaw-browser-control.md`
- Modify: `docs/浏览器对接标准.md` - Modify: `docs/浏览器对接标准.md`
- Modify: `docs/sgclaw_project_team_kickoff.md` - Modify: `docs/archive/项目管理与排期/sgclaw_project_team_kickoff.md`
- [ ] **Step 1: Write acceptance checklist** - [ ] **Step 1: Write acceptance checklist**

View File

@@ -1,8 +1,8 @@
# frontend 目录说明 # frontend 目录说明
当前 `frontend/` 保留开发验证相关内容 当前 `frontend/` 保留验证与归档文件
- `sgClaw验证/`:本地验证页面与脚本。 - `archive/sgClaw验证-已归档/`历史本地验证页面与脚本(含 Vue 2 验证页、`serve.sh``download-libs.sh``testRunner.js`
原先用于领导演示的网页与图文件已归档到: 原先用于领导演示的网页与图文件已归档到:

View File

@@ -0,0 +1,13 @@
# 前端归档资源
## 已归档内容
- `sgClaw验证-已归档/`历史本地验证页面与脚本Vue 2 验证页面、服务脚本、离线依赖下载脚本、测试运行器)。
## 使用说明
这是历史资产,不作为项目主线运行链路;如需复现旧版手工验证流程,可在该目录下直接执行:
```bash
bash frontend/archive/sgClaw验证-已归档/serve.sh
```

View File

@@ -13,7 +13,7 @@
- `cp /home/zyl/projects/superRpa/src/chrome/browser/resources/superrpa/devtools/functions/sgclaw-chat/sgclaw-chat.ts /tmp/sgclaw-chat-backup.ts` - `cp /home/zyl/projects/superRpa/src/chrome/browser/resources/superrpa/devtools/functions/sgclaw-chat/sgclaw-chat.ts /tmp/sgclaw-chat-backup.ts`
2. 复制新文件: 2. 复制新文件:
- `cp frontend/sgClaw验证/superrpa_migration/sgclaw-chat.ts /home/zyl/projects/superRpa/src/chrome/browser/resources/superrpa/devtools/functions/sgclaw-chat/sgclaw-chat.ts` - `cp frontend/archive/sgClaw验证-已归档/superrpa_migration/sgclaw-chat.ts /home/zyl/projects/superRpa/src/chrome/browser/resources/superrpa/devtools/functions/sgclaw-chat/sgclaw-chat.ts`
3. (可选)保留兼容: 3. (可选)保留兼容:
- 现有 `sgclaw-chat.html.ts``sgclaw-chat.css.ts` 仍是占位导出,不影响本组件内联模板; - 现有 `sgclaw-chat.html.ts``sgclaw-chat.css.ts` 仍是占位导出,不影响本组件内联模板;