component-docs
component-docs copied to clipboard
bytecodealliance
Consider a cookbook section
As suggested by @jeffparsons, we should consider a cookbook section (similar to the likes of the Rust cookbook) that enumerates and shows common tasks that one might want to do involving components. This is a great way for readers who "just want to do X" to find a section on X and copy/paste their way to success.
Some challenges with this approach is that we have L number of languages we support, and with E number of examples, we would need to write and maintain L x E tutorials which seems like a maintenance nightmare.
For this type of section, it might be nice to switch over to using docusaurus so we can have a tab for each language
Hey @rylev & @kate-goldenring what do you think about a hub-and-spoke model for this? With the component-docs effectively targeting one unified tutorial, with mentions of example projects in other languages (and links to the code that people can read/pull and modify).
As best practices/ground truth changes for other languages, I think it might be best to keep examples closer to the language-specific repositories involved.
I agree on the cookbook section, but it seems like to avoid the toil that L x E would require, exclusively focusing on language-independent guides -- i.e. using tools like wasm-tools or wac when dealing at a higher level (or lower level -- ex. WAT) than language-specific integrations might be helpful.
I could see the cookbook living in the component book but it is a series of links to the example implementations that like in the language toolchain projects. So the component book can be the unified reference but not maintain the implementations