Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ Delivered changes are recorded here. Version tags use `v` followed by a semantic

## [Unreleased]

No unreleased changes.
### Added

- Research workspace specification covering conversation, execution state, live artifact revisions, evidence navigation, responsive layouts and application acceptance scenarios.
- Minimal OpenLab Harness specification and ADR 0002 selecting a self-developed first runtime, AG-UI at the Platform gateway and assistant-ui for conversation.

### Changed

- Product, architecture, logging, architecture diagram and bilingual README now describe Platform-owned conversations, steps, human interactions and artifacts independently of runtime, model, tools and UI.
- OpenCode becomes an optional future adapter; ADR 0001 preserves the historical selection with a supersession notice. This revision delivers documentation only, with no application code or new runtime dependency.

## [0.0.1] - 2026-10-24

Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ OpenLab is a local-first research workspace being designed to connect open resea
| Automated documentation, workflow, and secret checks | Available in GitHub Actions and local tooling |
| Local service with browser UI, Windows first | Planned |
| Projects, skill installation, model configuration, and literature research | Planned |
| Supervisor-Skills execution through OpenCode | Planned; not an endorsed or verified integration yet |
| OpenLab Harness: default single-agent literature runtime | Specified; implementation and native Windows validation planned |
| Supervisor-Skills execution through the platform runtime adapter | Planned; not an endorsed or verified integration yet |
| Conversation, execution state, and live artifacts workspace | Specified with assistant-ui and AG-UI; no runnable UI yet |
| Source tracking, execution history, and artifact export | Specified; implementation planned |

## First research release
Expand All @@ -44,7 +46,9 @@ The initial application is intended to start locally and open in a browser. User

![Planned OpenLab architecture](assets/docs/architecture.svg)

OpenLab will own projects, run records, artifacts, and provenance. A replaceable adapter will connect an existing agent runtime. The [architecture](docs/architecture.md) separates this design from functionality already implemented.
OpenLab is an open research platform, not a wrapper around a single agent framework. It will own projects, conversations, execution records, sources, artifacts and provenance. Agent runtimes, models, scientific tools and user interfaces must be independently replaceable; research records remain owned by OpenLab and its users.

The planned workspace combines project navigation, conversation with execution state, and live artifacts. assistant-ui provides the conversation foundation; the Platform gateway uses AG-UI. shadcn/ui and AI Elements supply supporting views, while CopilotKit is an interaction reference without an SDK dependency. The first runtime is the minimal self-developed OpenLab Harness behind RuntimeAdapter; OpenCode is a later optional adapter. See [architecture](docs/architecture.md) and [ADR 0002](docs/decisions/0002-workspace-and-harness.md) for the current design and its implementation gates.

## Documentation

Expand All @@ -53,7 +57,10 @@ OpenLab will own projects, run records, artifacts, and provenance. A replaceable
| [Original vision, Chinese](docs/vision.zh-CN.md) | Founding product vision, preserved as supplied |
| [Product specification](docs/product.md) | Users, first milestone, behavior, and acceptance criteria |
| [Architecture and contracts](docs/architecture.md) | Components, research objects, and runtime interface |
| [Research workspace](docs/workspace.md) | Three-region layout, interaction states, live artifacts and UI acceptance |
| [OpenLab Harness](docs/harness.md) | Minimal first runtime, replaceable capabilities and execution gates |
| [Technical decisions](docs/decisions/0001-foundation.md) | Accepted baseline and implementation gates |
| [Workspace and Harness decision](docs/decisions/0002-workspace-and-harness.md) | Current UI/protocol and default-runtime selection; supersedes OpenCode first |
| [Logging and provenance](docs/logging.md) | Diagnostics, research records, retention, and export |
| [Product mark](docs/brand.md) | Vector assets, exact symmetry, and reproduction |
| [Repository operations](docs/maintaining.md) | GitHub settings, labels, checks, and release procedure |
Expand Down
13 changes: 10 additions & 3 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ OpenLab 致力于建立本地优先的科研工作空间,将已有的开源科
| 文档、工作流与密钥扫描 | GitHub Actions 与本地工具提供 |
| Windows 优先、本地启动、浏览器交互 | 计划实现 |
| 项目管理、技能安装、模型配置与文献研究 | 计划实现 |
| 通过 OpenCode 执行 Supervisor-Skills | 计划集成,尚未通过执行验证 |
| OpenLab Harness:默认单 Agent 文献研究运行时 | 已定义规格,待实现及原生 Windows 验证 |
| 通过平台运行时适配器执行 Supervisor-Skills | 计划集成,尚未通过执行验证 |
| 对话、执行状态与实时研究产物工作台 | 已确定 assistant-ui 与 AG-UI 方向,目前没有可运行界面 |
| 来源追踪、运行历史与成果导出 | 已定义规格,待实现 |

## 首个科研版本
Expand All @@ -40,15 +42,20 @@ OpenLab 致力于建立本地优先的科研工作空间,将已有的开源科

## 架构方向

![OpenLab 规划架构:浏览器、本地控制层、项目文件、技能目录与运行时适配器](assets/docs/architecture.svg)
![OpenLab 规划架构:科研工作台、平台 API 与 AG-UI 网关、平台研究记录、运行时适配器及 OpenLab Harness](assets/docs/architecture.svg)

平台持有项目、运行记录、成果和来源信息,通过可替换的适配器连接 Agent 运行时。实现边界见[架构文档](docs/architecture.md)。
OpenLab 是开放科研平台,不是某个 Agent 框架的封装。平台持有项目、对话、执行记录、成果和来源信息;运行时、模型、科研工具和界面必须能够独立替换,研究记录与成果由 OpenLab 及用户掌握。

科研工作台采用“项目导航 + 对话与执行状态 + 实时研究产物”布局。assistant-ui 提供对话基础,平台网关采用 AG-UI,shadcn/ui 与 AI Elements 补充计划、审批和引用等视图;CopilotKit 作为交互模式参考,首版不引入其 SDK。首个运行时改为通过 RuntimeAdapter 接入的最小自研 OpenLab Harness;OpenCode 保留为后续可选适配器。实现边界见[架构文档](docs/architecture.md)与[新技术决策](docs/decisions/0002-workspace-and-harness.md)。

## 文档导航

- [原始产品愿景](docs/vision.zh-CN.md):保留用户提供的完整规划。
- [产品规格](docs/product.md):用户、首版流程和验收条件。
- [架构与接口](docs/architecture.md)、[技术决策](docs/decisions/0001-foundation.md)。
- [科研工作台规格](docs/workspace.md):布局、交互状态、实时成果与界面验收。
- [OpenLab Harness 规格](docs/harness.md):最小运行时、可替换接口与验证条件。
- [工作台与 Harness 决策](docs/decisions/0002-workspace-and-harness.md):记录界面协议和默认运行时的路线变更。
- [日志与科研追溯规范](docs/logging.md)。
- [产品标识与矢量文件](docs/brand.md):精确镜像轮廓、圆弧与中心对称波浪。
- [仓库维护与发布](docs/maintaining.md)、[验证记录](docs/verification.md)、[变更日志](CHANGELOG.md)。
Expand Down
13 changes: 12 additions & 1 deletion THIRD_PARTY_NOTICES.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,15 @@ OpenLab's Apache-2.0 license applies to OpenLab-authored material. Referenced or

The npm lockfile records exact development dependencies and integrity hashes. Their license metadata is available in the installed packages. CI downloads actionlint (MIT) and Gitleaks (MIT) from their official releases; pinned versions, archive URLs, and SHA-256 digests are recorded in [the tool manifest](scripts/tools.json). These executables are cached locally and are not included in the source release.

GitHub Actions used by the workflows retain their upstream licenses and are pinned to immutable commit SHAs. OpenCode is an architectural runtime selection, not a bundled dependency in v0.0.1. Any future application distribution must include an updated dependency and license inventory.
GitHub Actions used by the workflows retain their upstream licenses and are pinned to immutable commit SHAs. Any future application distribution must include an updated dependency and license inventory.

## Planned application components and design references

- [assistant-ui](https://github.com/assistant-ui/assistant-ui) is the planned conversation foundation, with its [official AG-UI adapter](https://www.assistant-ui.com/docs/runtimes/ag-ui/overview).
- [AG-UI](https://docs.ag-ui.com/introduction) is the selected frontend interaction protocol. OpenLab retains its own research archive and runtime contracts.
- [shadcn/ui AI Elements](https://ui.shadcn.com/docs/ai-elements) provides supporting UI composition patterns; copied component code must retain applicable source and license records.
- [CopilotKit](https://github.com/CopilotKit/CopilotKit) is an interaction-pattern reference; no SDK or hosted service is selected for the first release.
- OpenCode was the original first-runtime selection in ADR 0001. [ADR 0002](docs/decisions/0002-workspace-and-harness.md) selects self-developed OpenLab Harness and retains OpenCode as an optional future adapter.
- DeepSeek Harness is named in the supplied planning material as architectural inspiration. No upstream implementation or license has been independently established in this revision; no code is copied or bundled on that basis.

These application components are not installed or bundled in v0.0.1. The referenced documentation was reviewed on 2026-10-24; exact dependency/component revisions, license terms and compatibility must be recorded before implementation distribution. A design reference does not imply upstream endorsement.
79 changes: 50 additions & 29 deletions assets/docs/architecture.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading