search

suborbital / docs

Documentation monorepo for Suborbital projects and products
https://docs.suborbital.dev
Apache License 2.0
8 stars 5 forks source link

fix: document WasmEdge version dependency #152

Closed LauraLangdon closed 1 year ago

LauraLangdon commented 2 years ago

Closes #145. I copied the callout syntax from another page of ours, and maybe it's specific to Docusaurus because it doesn't display as a callout box with regular Markdown?

flaki commented 2 years ago

Hmm this is a bit weird to me just blurted out like that.

We have this in the "Reactr ❤️ WebAssembly" page:

By default, Reactr uses the Wasmer runtime internally, but supports the Wasmtime runtime as well. Pass -tags wasmtime to any go command to use Wasmtime. Wasmtime is not yet supported on ARM.

Could we perhaps move that side note into the main page / install instructions? Then this dependency would make a lot more sense IMO.

LauraLangdon commented 2 years ago

Could we perhaps move that side note into the main page / install instructions? Then this dependency would make a lot more sense IMO.

Isn't this the install page for Reactr?

flaki commented 2 years ago

Could we perhaps move that side note into the main page / install instructions? Then this dependency would make a lot more sense IMO.

Isn't this the install page for Reactr?

I meant, could we move the bit I quoted from the Reactor <3 WebAssembly page into the one you edited in this PR to give the note you added more context?

As Reactr can be used with any number of engine backends, and WasmEdge isn't even the default one, that would add more context ("if you do want to use WasmEdge you need to explicitly say so -- and in that case you should use a specific version of it").

LauraLangdon commented 2 years ago

Could we perhaps move that side note into the main page / install instructions? Then this dependency would make a lot more sense IMO.

Isn't this the install page for Reactr?

I meant, could we move the bit I quoted from the Reactor <3 WebAssembly page into the one you edited in this PR to give the note you added more context?

As Reactr can be used with any number of engine backends, and WasmEdge isn't even the default one, that would add more context ("if you do want to use WasmEdge you need to explicitly say so -- and in that case you should use a specific version of it").

Gotcha! Yep, that makes total sense!

LauraLangdon commented 1 year ago

Closing due to the impending deprecation of Reactr.