Skip to content

fix(docs): render README architecture from a local SVG #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IsaacHuo merged 1 commit into from
Oct 24, 2026
Merged

fix(docs): render README architecture from a local SVG #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 1 addition & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,7 @@ The initial application is intended to start locally and open in a browser. User

## Architecture direction

```mermaid
flowchart TD
UI[Browser workspace] --> API[Local control plane]
API --> DATA[Project metadata and research files]
API --> ADAPTER[Runtime adapter]
ADAPTER --> AGENT[OpenCode runtime]
API --> SKILLS[Versioned skill catalog]
AGENT --> TOOLS[Controlled retrieval and research tools]
TOOLS --> SOURCES[Literature and data providers]
AGENT --> MODELS[User-selected model providers]
```
![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.

Expand Down
12 changes: 1 addition & 11 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,7 @@ OpenLab 致力于建立本地优先的科研工作空间，将已有的开源科

## 架构方向

```mermaid
flowchart TD
UI[浏览器工作空间] --> API[本地控制层]
API --> DATA[项目元数据与研究文件]
API --> ADAPTER[运行时适配器]
ADAPTER --> AGENT[OpenCode 运行时]
API --> SKILLS[版本化技能目录]
AGENT --> TOOLS[受控检索与科研工具]
TOOLS --> SOURCES[文献与数据源]
AGENT --> MODELS[用户选择的模型服务]
```
![OpenLab 规划架构：浏览器、本地控制层、项目文件、技能目录与运行时适配器](assets/docs/architecture.svg)

平台持有项目、运行记录、成果和来源信息，通过可替换的适配器连接 Agent 运行时。实现边界见[架构文档](docs/architecture.md)。

Expand Down
49 changes: 49 additions & 0 deletions assets/docs/architecture.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/verification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ The original Chinese vision was copied byte-for-byte; its SHA-256 is `d016e43369

The online merge and release evidence is retained in the foundation PR, push workflow and v0.0.1 Release linked below. These live records are the authority for the final publishing outcome.

GitHub page inspection confirmed the README mark, navigation and license display. The initial remote Mermaid renderer failed in that inspection, so both READMEs now use a repository-owned SVG architecture diagram that loads without a diagram rendering service. The Windows/Linux PR checks and the main push checks passed for the foundation merge; subsequent workflow runs record the rendering fix and release gate outcomes.

## Baseline checks

- `npm ci`: install development dependencies from the committed lockfile.
Expand Down
Loading