Skip to content
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.

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

Consider a cookbook section #121

Open
rylev opened this issue Mar 21, 2024 · 3 comments
Open

Consider a cookbook section #121

rylev opened this issue Mar 21, 2024 · 3 comments

Comments

@rylev
Copy link
Collaborator

rylev commented Mar 21, 2024

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.

@kate-goldenring
Copy link
Collaborator

For this type of section, it might be nice to switch over to using docusaurus so we can have a tab for each language

@vados-cosmonic
Copy link
Contributor

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.

@kate-goldenring
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants