diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/design.md | 9 | ||||
| -rw-r--r-- | docs/http.md | 8 | ||||
| -rw-r--r-- | docs/validation.md | 2 |
3 files changed, 10 insertions, 9 deletions
diff --git a/docs/design.md b/docs/design.md index d12b92c..2013b3e 100644 --- a/docs/design.md +++ b/docs/design.md @@ -57,7 +57,7 @@ or buffers. `http.Client` negotiates HTTP/1.1 upgrades using `std.http.Client`, including its certificate-verified HTTPS support. `http.Bridge` relays between an accepted WebSocket and arbitrary standard readers/writers, including UART adapters. The runnable application's web UI, device leases, deadlines, and -origin policy remain in `app/`. See [HTTP ownership and usage](http.md). +origin policy remain in `web/`. See [HTTP ownership and usage](http.md). `Quic(OpenSSL, alpn)` is an optional OpenSSL 3.6+ adapter with a single ordered bidirectional stream per connection. It preserves the previous Pardes transport: @@ -68,15 +68,16 @@ protocol core. Accepted connections must close before their shared listener. # Related programs -Programs built on the library ship from this repository in sibling -directories of `src/` (`introspect/`, `9player/`), never inside it: each has +Programs built on the library ship from this repository as `cloud9/<name>/`, +sibling directories of `src/` with `9`-prefixed names (`web/` builds `9web`; +`9proc/` and `9ns/` build `9proc-demo` and `9ns`), never inside it: each has its own `src/`, `test/`, `docs/`, README and a `build.zig` fragment (`pub fn add(b, ctx)`) that the root `build.zig` imports, passes the resolved target, optimize mode and the `cloud9` module to, and enables with a `-D<name>` toggle. Fragments register namespaced steps (`<name>`, `<name>-test`, ...), never call `standardTargetOptions`, and use root-relative `b.path("<name>/...")`. The library keeps its contract: mounting, namespaces, -threads, allocation and process policy stay in the program. `introspect` is +threads, allocation and process policy stay in the program. `9proc` is also exported as a module next to `cloud9` for dependents. New related programs follow this layout. diff --git a/docs/http.md b/docs/http.md index f486d52..4e92e5e 100644 --- a/docs/http.md +++ b/docs/http.md @@ -16,7 +16,7 @@ flowchart LR ```sh zig build -Doptimize=ReleaseSafe -./zig-out/bin/cloud9-http --upstream tcp:127.0.0.1:564 +./zig-out/bin/9web --upstream tcp:127.0.0.1:564 # Or run directly: zig build serve -Doptimize=ReleaseSafe -- --upstream unix:/path/to/9p.sock ``` @@ -91,7 +91,7 @@ For a configured serial device: ```sh # Set raw mode, baud rate, and flow control with your platform's serial tools. -./zig-out/bin/cloud9-http --upstream file:/dev/ttyUSB0 +./zig-out/bin/9web --upstream file:/dev/ttyUSB0 ``` The serial path transports 9P bytes; it does not interpret ESP32 boot logs or @@ -174,9 +174,9 @@ checks; it does not allocate fids, mount filesystems, or implement a filesystem. Each Bridge value runs once. Timeout and cancellation stop both pumps before returning. The caller owns and closes the underlying streams. -`app/client.zig` is a browser ABI around the same `cloud9.Client` and `Stat` +`web/client.zig` is a browser ABI around the same `cloud9.Client` and `Stat` implementations. Its WASM memory is fixed at 1 MiB and it imports no host -functions. `app/web/client.mjs` supplies asynchronous WebSocket I/O and file +functions. `web/static/client.mjs` supplies asynchronous WebSocket I/O and file operations. Each browser Client owns a separate WASM instance. The JavaScript contains no 9P encoder or decoder. diff --git a/docs/validation.md b/docs/validation.md index 98b73d6..5b34b82 100644 --- a/docs/validation.md +++ b/docs/validation.md @@ -86,7 +86,7 @@ HTTP/3 is not implemented or tested. The [HTTP E2E report](results/http-e2e.json) records the scenarios and byte counts. The run's screenshots and TLS fixtures remain in `.zig-cache/e2e-3HAs6G/`. -`zig build -Doptimize=ReleaseSafe` installs the standalone `cloud9-http` binary; +`zig build -Doptimize=ReleaseSafe` installs the standalone `9web` binary; `zig build web -Doptimize=ReleaseSafe` also installs the separate browser assets. See [HTTP usage and ownership](http.md) for the reusable API and runnable gateway. |