Skip to content

Update interfaces page to add proposals and proposal process (source) #32

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
ericgregory merged 1 commit into from
Aug 14, 2024
Merged

Update interfaces page to add proposals and proposal process (source) #32

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
116 changes: 114 additions & 2 deletions docs/interfaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,118 @@ WASI P1 APIs were defined with WITX Interface Description Language (IDL), which

## Proposals for the standard

All WASI APIs are **proposals** for standardization by the WASI Subgroup. The API proposals in WASI 0.1 and 0.2 met implementation and portability criteria for inclusion at the time of those releases.
All WASI APIs are **proposals** for standardization by the WASI Subgroup. The API proposals in WASI 0.1 and 0.2 met implementation and portability criteria for inclusion at the time of those releases. A proposal advances through the following stages as defined in the [WebAssembly W3C process](https://github.com/WebAssembly/meetings/blob/main/process/phases.md):

All active WASI API proposals can be found on the [WASI GitHub repository](https://github.com/WebAssembly/WASI/blob/main/Proposals.md), along with the [process for making a proposal](https://github.com/WebAssembly/WASI/blob/main/Contributing.md#the-phase-process).
* **Phase 0 - Pre-proposal**: The pre-proposal phase serves as a way to share ideas. At this phase, the WASI subgroup has not yet decided that the pre-proposal is in scope for WASI, and there may be overlap between pre-proposals.
* **Phase 1 - Feature proposal**: In this phase, the proposal is added to the proposal list and a new fork of the spec repo is created.
* **Phase 2 - Proposed spec text available**: During this phase, one or more implementations prototype the feature and a test suite is added.
* **Phase 3 - Implementation phase**: At this phase, project champions create releases following the conventions of semantic versioning (semver).
* **Phase 4 - Standardize the feature:** At this point, the feature is fully handed off to the Working Group, where edge cases are considered and only minor changes occur.
* **Phase 5 - The feature is standardized**: Once the Working Group reaches consensus that the feature is complete, editors perform final editorial tweaks and merge the feature into the main branch of the primary spec repo.

Proposals are first made to the **WASI Subgroup** of the [WebAssembly Community Group](https://www.w3.org/community/webassembly/). (See the [WASI Subgroup's meeting schedule](https://github.com/WebAssembly/meetings/tree/main/wasi).)

All active WASI API proposals can be found on the [WASI GitHub repository](https://github.com/WebAssembly/WASI/blob/main/Proposals.md), along with the [process for making a proposal](https://github.com/WebAssembly/WASI/blob/main/Contributing.md#the-phase-process).

## Active Proposals

### Phase 5 - The Feature is Standardized (WG)

| API Proposal | Repository |
| ----------------------------------------------------------------------| -------------------------------------- |

### Phase 4 - Standardize the Feature (WG)

| API Proposal | Repository |
| ----------------------------------------------------------------------| -------------------------------------- |

### Phase 3 - Implementation Phase (CG + WG)

| API Proposal | Repository |
| --------------------------------------------------------------------- | -------------------------------------- |
| [I/O][wasi-io] | https://github.com/WebAssembly/wasi-io |
| [Clocks][wasi-clocks] | https://github.com/WebAssembly/wasi-clocks |
| [Random][wasi-random] | https://github.com/WebAssembly/wasi-random |
| [Filesystem][wasi-filesystem] | https://github.com/WebAssembly/wasi-filesystem |
| [Sockets][wasi-sockets] | https://github.com/WebAssembly/wasi-sockets |
| [CLI][wasi-cli] | https://github.com/WebAssembly/wasi-cli |
| [HTTP][wasi-http] | https://github.com/WebAssembly/wasi-http |

### Phase 2 - Proposed Spec Text Available (CG + WG)

| API Proposal | Repository |
| ----------------------------------------------------- | -------------------------------------------- |
| [Machine Learning (wasi-nn)][wasi-nn] | https://github.com/WebAssembly/wasi-nn |
| [Clocks: Timezone][wasi-clocks] | https://github.com/WebAssembly/wasi-clocks |

### Phase 1 - Feature Proposal (CG)

| API Proposal | Repository |
| ------------------------------------------------------------------------ | -------------------------------------- |
| [Blob Store][wasi-blob-store] | https://github.com/WebAssembly/wasi-blob-store |
| [Crypto][wasi-crypto] | https://github.com/WebAssembly/wasi-crypto |
| [Digital I/O][wasi-digital-io] | https://github.com/WebAssembly/wasi-digital-io |
| [Distributed Lock Service][wasi-distributed-lock-service] | https://github.com/WebAssembly/wasi-distributed-lock-service |
| [I2C][wasi-i2c] | https://github.com/WebAssembly/wasi-i2c |
| [Key-value Store][wasi-kv-store] | https://github.com/WebAssembly/wasi-kv-store |
| [Logging][wasi-logging] | https://github.com/WebAssembly/wasi-logging |
| [Messaging][wasi-messaging] | https://github.com/WebAssembly/wasi-messaging |
| [Observe][wasi-observe] | https://github.com/dylibso/wasi-observe |
| [Parallel][wasi-parallel] | https://github.com/WebAssembly/wasi-parallel |
| [Pattern Match][wasi-pattern-match] | https://github.com/WebAssembly/wasi-pattern-match |
| [Runtime Config][wasi-runtime-config] | https://github.com/WebAssembly/wasi-runtime-config |
| [SPI][wasi-spi] | https://github.com/WebAssembly/wasi-spi |
| [SQL][wasi-sql] | https://github.com/WebAssembly/wasi-sql |
| [SQL Embed][wasi-sql-embed] | https://github.com/WebAssembly/wasi-sql-embed |
| [Threads][wasi-threads] | https://github.com/WebAssembly/wasi-native-threads |
| [URL][wasi-url] | https://github.com/WebAssembly/wasi-url |
| [USB][wasi-usb] | https://github.com/WebAssembly/wasi-usb |
| [WebGPU][wasi-webgpu] | https://github.com/WebAssembly/wasi-webgpu |

### Phase 0 - Pre-Proposal (CG)

| Proposal | Repository |
| -------------------------------------------------------------------------------- | -------------------------------------- |
| [proxy-wasm/spec][wasi-proxy-wasm] (will advance as multiple, smaller proposals) | https://github.com/proxy-wasm/spec |

## Versioning

Proposals remain in the 0.x semver range until they reach Phase 5 and are fully standardized. At that point, a 1.0 release should be made available.

For some APIs, it makes sense to add new features after the API itself has reached Phase 5. These feature additions should go through the same standardization process. Once they have reached Phase 5, the minor version number of the release should be incremented.

Some APIs may require backwards-incompatible changes over time. In these cases, proposals are allowed to increment the major version number _only if_ the old API can be implmented in terms of the new API. As part of the new version, champions are expected to provide a tool that enables this backwards-compatibility. If that is not possible, then a new API proposal with a new name should be started. The original API can then be deprecated over time if it makes sense to do so.

[WebAssembly CG Phases process]: https://github.com/WebAssembly/meetings/blob/master/process/phases.md
[witx]: https://github.com/WebAssembly/WASI/blob/main/tools/witx-docs.md
[ephemeral/snapshot/old process]: https://github.com/WebAssembly/WASI/blob/master/phases/README.md

[wasi-blob-store]: https://github.com/WebAssembly/wasi-blob-store
[wasi-clocks]: https://github.com/WebAssembly/wasi-clocks
[wasi-crypto]: https://github.com/WebAssembly/wasi-crypto
[wasi-data]: https://github.com/singlestore-labs/wasi-data
[wasi-digital-io]: https://github.com/WebAssembly/wasi-digital-io
[wasi-distributed-lock-service]: https://github.com/WebAssembly/wasi-distributed-lock-service
[wasi-filesystem]: https://github.com/WebAssembly/wasi-filesystem
[wasi-http]: https://github.com/WebAssembly/wasi-http
[wasi-i2c]: https://github.com/WebAssembly/wasi-i2c
[wasi-io]: https://github.com/WebAssembly/wasi-io
[wasi-kv-store]: https://github.com/WebAssembly/wasi-kv-store
[wasi-logging]: https://github.com/WebAssembly/wasi-logging
[wasi-messaging]: https://github.com/WebAssembly/wasi-messaging
[wasi-nn]: https://github.com/WebAssembly/wasi-nn
[wasi-observe]: https://github.com/dylibso/wasi-observe
[wasi-parallel]: https://github.com/WebAssembly/wasi-parallel
[wasi-pattern-match]: https://github.com/WebAssembly/wasi-pattern-match
[wasi-proxy-wasm]: https://github.com/proxy-wasm/spec
[wasi-random]: https://github.com/WebAssembly/wasi-random
[wasi-runtime-config]: https://github.com/WebAssembly/wasi-runtime-config
[wasi-sockets]: https://github.com/WebAssembly/wasi-sockets
[wasi-spi]: https://github.com/WebAssembly/wasi-spi
[wasi-sql]: https://github.com/WebAssembly/wasi-sql
[wasi-sql-embed]: https://github.com/WebAssembly/wasi-sql-embed
[wasi-threads]: https://github.com/WebAssembly/wasi-native-threads
[wasi-url]: https://github.com/WebAssembly/wasi-url
[wasi-usb]: https://github.com/WebAssembly/wasi-usb
[wasi-webgpu]: https://github.com/WebAssembly/wasi-webgpu
[wasi-cli]: https://github.com/WebAssembly/wasi-cli
2 changes: 1 addition & 1 deletion docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ const config = {
items: [
{
label: 'Introduction',
to: '/docs/intro',
to: '/',
},
],
},
Expand Down