Skip to content

Commit b07a353

Browse files
committed
docs: refresh architecture and package wording
1 parent 241b575 commit b07a353

8 files changed

Lines changed: 10 additions & 13 deletions

File tree

docs/architecture/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Execbox Architecture Overview
22

3-
Execbox is the code-execution part of the `execbox` workspace. It turns host tool catalogs into callable guest namespaces, lets those namespaces wrap MCP tools, and pairs with executor packages that decide where and how guest JavaScript runs.
3+
Execbox is the code-execution part of the `execbox` workspace. It turns host tool catalogs into callable guest namespaces, lets those namespaces wrap MCP tools, and uses executor backends that decide where and how guest JavaScript runs.
44

55
This doc set is for two audiences:
66

docs/architecture/execbox-executors.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Execbox Executors
22

3-
This page explains how the current executors and QuickJS host modes differ and what trade-offs they make.
3+
This page explains how the available executors and QuickJS host modes differ and what trade-offs they make.
44

55
## Executor Comparison
66

@@ -60,7 +60,7 @@ That design gives QuickJS two useful properties:
6060

6161
That means:
6262

63-
- it does not depend on `execbox-protocol`
63+
- it does not use `@execbox/core/protocol`
6464
- it avoids the extra message loop used by worker-backed execution
6565
- its runtime-specific bridge logic still lives in the executor package itself
6666
- it aligns to the same runner-level shape used by QuickJS and transport-backed execution
@@ -69,7 +69,7 @@ The package keeps its native bridge where it belongs while still sharing the sam
6969

7070
## Worker-Hosted QuickJS
7171

72-
`QuickJsExecutor` with `host: "worker"` uses a worker thread for lifecycle isolation, but it does not invent a second scripting model. It loads the same QuickJS session runner used by the inline QuickJS executor, reuses the shared QuickJS protocol endpoint inside the worker, and uses the shared `execbox-protocol` host session on the parent side. By default it keeps a worker shell warm between executions; `mode: "ephemeral"` switches to a fresh worker per execution.
72+
`QuickJsExecutor` with `host: "worker"` uses a worker thread for lifecycle isolation, but it does not invent a second scripting model. It loads the same QuickJS session runner used by the inline QuickJS executor, reuses the shared QuickJS protocol endpoint inside the worker, and uses the shared `@execbox/core/protocol` host session on the parent side. By default it keeps a worker shell warm between executions; `mode: "ephemeral"` switches to a fresh worker per execution.
7373

7474
```mermaid
7575
sequenceDiagram
@@ -90,7 +90,7 @@ sequenceDiagram
9090

9191
## Process-Hosted QuickJS
9292

93-
`QuickJsExecutor` with `host: "process"` uses the same message-driven model as the worker host, but runs it behind a child-process boundary. It loads the same QuickJS session runner used by the inline QuickJS executor, reuses the same QuickJS protocol endpoint inside the child, and uses the shared `execbox-protocol` host session on the parent side. By default it keeps a child-process shell warm between executions; `mode: "ephemeral"` switches to a fresh child process per execution.
93+
`QuickJsExecutor` with `host: "process"` uses the same message-driven model as the worker host, but runs it behind a child-process boundary. It loads the same QuickJS session runner used by the inline QuickJS executor, reuses the same QuickJS protocol endpoint inside the child, and uses the shared `@execbox/core/protocol` host session on the parent side. By default it keeps a child-process shell warm between executions; `mode: "ephemeral"` switches to a fresh child process per execution.
9494

9595
```mermaid
9696
sequenceDiagram

docs/architecture/execbox-protocol-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ Example execution with one tool call:
274274

275275
## Scope Of This Reference
276276

277-
This reference describes the current message contract and host-session semantics used inside the execbox package family. It does not specify:
277+
This reference describes the message contract and host-session semantics used inside the execbox package family. It does not specify:
278278

279279
- a built-in network transport such as HTTP or WebSocket
280280
- multi-execution multiplexing over one shared long-lived channel

docs/architecture/execbox-runner-specification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Use it when you want to implement a non-TypeScript runner, such as a Go remote r
2222

2323
## Status And Scope
2424

25-
This is the normative runner specification for the current execbox runner contract.
25+
This is the normative runner specification for the execbox runner contract.
2626

2727
It defines:
2828

docs/architecture/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Execbox Architecture Overview
22

3-
Execbox is the code-execution part of the `execbox` workspace. It turns host tool catalogs into callable guest namespaces, lets those namespaces wrap MCP tools, and pairs with executor packages that decide where and how guest JavaScript runs.
3+
Execbox is the code-execution part of the `execbox` workspace. It turns host tool catalogs into callable guest namespaces, lets those namespaces wrap MCP tools, and uses executor backends that decide where and how guest JavaScript runs.
44

55
This doc set is for two audiences:
66

docs/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@ hero:
1414
- theme: alt
1515
text: Explore Examples
1616
link: /examples
17-
- theme: alt
18-
text: Read the Architecture
19-
link: /architecture/
2017

2118
features:
2219
- title: Code-first tool use

packages/core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Docs: https://execbox.aallam.com
1616

1717
## Pair It With an Executor
1818

19-
`@execbox/core` does not execute code on its own. Pair it with one of the executor packages:
19+
`@execbox/core` does not execute code on its own. Pair it with an executor backend:
2020

2121
| Package | Best for |
2222
| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

packages/remote/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Transport-backed remote executor for `@execbox/core`.
77

88
Docs: https://execbox.aallam.com
99

10-
## Choose `execbox-remote` When
10+
## Choose `@execbox/remote` When
1111

1212
- you want execbox execution to live outside the application process
1313
- you already own the transport and runtime deployment shape

0 commit comments

Comments
 (0)