From f399c033d64e8442b7e34ba140404a31daf2c172 Mon Sep 17 00:00:00 2001 From: jtneev Date: Thu, 18 Jan 2024 13:02:50 -0700 Subject: [PATCH] small edits --- src/apis/kinode_wit.md | 6 +++--- src/apis/net.md | 2 +- src/apis/uqbar_wit.md | 1 - 3 files changed, 4 insertions(+), 5 deletions(-) delete mode 100644 src/apis/uqbar_wit.md diff --git a/src/apis/kinode_wit.md b/src/apis/kinode_wit.md index b007d322..a3808a47 100644 --- a/src/apis/kinode_wit.md +++ b/src/apis/kinode_wit.md @@ -3,7 +3,7 @@ Throughout this book, readers will see references to [WIT](https://component-model.bytecodealliance.org/design/wit.html), the [WebAssembly Component Model](https://github.com/WebAssembly/component-model). WIT, or Wasm Interface Type, is a language for describing the types and functions that are available to a WebAssembly module. In conjunction with the Component Model itself, WIT allows for the creation of WebAssembly modules that can be used as components in a larger system. -This standard has been under development for many years, and while still under construction, it's the perfect tool for building an operating-system-like environment for apps built in Wasm. +This standard has been under development for many years, and while still under construction, it's the perfect tool for building an operating-system-like environment for Wasm apps. Kinode OS uses WIT to present a standard interface for Kinode processes. This interface is a set of types and functions that are available to all processes. @@ -15,9 +15,9 @@ To see exactly how to use WIT to write Kinode processes, see the [My First App]( To see `kinode.wit` for itself, see the [file in the GitHub repo](https://github.com/uqbar-dao/kinode-wit/blob/master/kinode.wit). Since this interface applies to all processes, it's one of the places in the OS where breaking changes are most likely to make an impact. -To that end, the version of the WIT file that a process uses must be compatible with the version of Kinode OS that it's running on. +To that end, the version of the WIT file that a process uses must be compatible with the version of Kinode OS on which it runs. We intend to achieve perfect backwards compatibility upon first major release (1.0.0) of the OS and the WIT file. -After that point, since processes signal the version of the WIT file they use, subsequent updates can be made without breaking existing processes needing to change the version they use. +After that point, since processes signal the version of the WIT file they use, subsequent updates can be made without breaking existing processes or needing to change the version they use. ## Types diff --git a/src/apis/net.md b/src/apis/net.md index 8da29ce4..505d3300 100644 --- a/src/apis/net.md +++ b/src/apis/net.md @@ -19,7 +19,7 @@ The received `Request`s are handled in one of three ways: - If the `source.node` is our domain, but the `target.node` is not, the message is sent to the target using the [networking protocol](../networking_protocol.md) implementation. Let's look at `NetActions`. Note that this message type can be received from remote or local processes. -Different implementations of the networking protocol may reject actions depending on whether they were instigated locally or remotely, and also discriminate on what remote node sent the action. +Different implementations of the networking protocol may reject actions depending on whether they were instigated locally or remotely, and also discriminate on which remote node sent the action. This is, for example, where a router would choose whether or not to perform routing for a specific node<>node connection. ```rust diff --git a/src/apis/uqbar_wit.md b/src/apis/uqbar_wit.md deleted file mode 100644 index bc8c96e0..00000000 --- a/src/apis/uqbar_wit.md +++ /dev/null @@ -1 +0,0 @@ -# uqbar.wit