Stream: git-wasmtime

Topic: wasmtime / issue #3707 Documentation Improvement: wasmtim...

Wasmtime GitHub notifications bot (Jan 20 2022 at 21:48):

Kylebrown9 opened issue #3707:

The wasmtime crate has a fairly sparse readme, especially when compared to wasmer.

Most of the specific features I would suggest can be found on the aforementioned wasmer crate readme.

1. Use links for anything that has an associated page (e.g. on "wasmtime Webassembly runtime")
2. Offer a "usage" section with an example and links to where you can find more.
3. Offer a "features" section that describes any high-level features of the crate.
4. Add at least CI, crates.io version, and license badges.

While a bit more nebulous, the wasmer crate also has a much warmer feeling to it and makes a lot of appeals to users like

• mentioning that it is "the most popular WebAssembly runtime",
• emphasizing that "It's designed to be safe and secure, and runnable in any kind of environment",
• saying that wasmer is "Made with :heart:️ by the Wasmer team, for the community".

While it doesn't make sense for wasmtime to try to match these various appeals 1-to-1, it might make sense to think about what messages about wasmtime the crates page should try to convey to users about the tool, it's properties, and it's creators. One appeal that might make sense is to refer to wasmtime's status as part of the Bytecode Alliance.

Wasmtime GitHub notifications bot (Jan 20 2022 at 22:07):

Kylebrown9 edited issue #3707:

The wasmtime crate's readme is a bit sparse and isn't as thorough as the Rust - Wasmtime documentation page. Although it doesn't need to be (since they serve different purposes), it can and probably should be enhanced. By improving this page wasmtime can make itself more appealing and accessible to users looking at WebAssembly projects on crates.io.

One additional point of comparison is to the wasmer crate readme, which includes some features that can be borrowed.

1. Using links for anything that has an associated page (e.g. on "wasmtime Webassembly runtime")
2. Offering a "usage" section with an example and links to where you can find more.
3. Offering a "features" section that describes any high-level features of the crate.
4. The inclusion of CI, crates.io version, and license badges.

While a bit more nebulous, the wasmer crate also has a much warmer feeling to it and makes a lot of appeals to users like

• mentioning that it is "the most popular WebAssembly runtime",
• emphasizing that "It's designed to be safe and secure, and runnable in any kind of environment",
• saying that wasmer is "Made with :heart:️ by the Wasmer team, for the community".

While it doesn't make sense for wasmtime to try to match these various appeals 1-to-1, it might make sense to think about what messages about wasmtime the crates page should try to convey to users about the tool, it's properties, and it's creators. One appeal that might make sense is to refer to wasmtime's status as part of the Bytecode Alliance.

Wasmtime GitHub notifications bot (Jan 24 2022 at 20:33):

Kylebrown9 commented on issue #3707:

I recently noticed that the wat crate, and a number of other wasm-tools crates, actually do the sorts of things I'm suggesting. It might make sense to extract out the structure of the more refined READMEs into a template for Bytecode Alliance crates.

Wasmtime GitHub notifications bot (May 20 2022 at 20:33):

alexcrichton closed issue #3707:

The wasmtime crate's readme is a bit sparse and isn't as thorough as the Rust - Wasmtime documentation page. Although it doesn't need to be (since they serve different purposes), it can and probably should be enhanced. By improving this page wasmtime can make itself more appealing and accessible to users looking at WebAssembly projects on crates.io.

One additional point of comparison is to the wasmer crate readme, which includes some features that can be borrowed.

1. Using links for anything that has an associated page (e.g. on "wasmtime Webassembly runtime")
2. Offering a "usage" section with an example and links to where you can find more.
3. Offering a "features" section that describes any high-level features of the crate.
4. The inclusion of CI, crates.io version, and license badges.

While a bit more nebulous, the wasmer crate also has a much warmer feeling to it and makes a lot of appeals to users like

• mentioning that it is "the most popular WebAssembly runtime",
• emphasizing that "It's designed to be safe and secure, and runnable in any kind of environment",
• saying that wasmer is "Made with :heart:️ by the Wasmer team, for the community".

While it doesn't make sense for wasmtime to try to match these various appeals 1-to-1, it might make sense to think about what messages about wasmtime the crates page should try to convey to users about the tool, it's properties, and it's creators. One appeal that might make sense is to refer to wasmtime's status as part of the Bytecode Alliance.

Last updated: Nov 22 2024 at 16:03 UTC