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

Yew Agent documentation #3582

Open
3 of 8 tasks
TiemenSch opened this issue Jan 9, 2024 · 2 comments
Open
3 of 8 tasks

Yew Agent documentation #3582

TiemenSch opened this issue Jan 9, 2024 · 2 comments

Comments

@TiemenSch
Copy link

This is about:

  • A typo
  • Innaccurate/misleading documentation (e.g. technically incorrect advice)
  • Undocumented code
  • Outdated documentation
  • Other

Problem
https://github.com/yewstack/yew/blob/master/website/versioned_docs/version-0.21/concepts/agents.mdx

The agents page states that agent communication happens over the bincode codec while it merely is a default. However, just like with gloo-worker itself, the Codec is already perfectly changeable.

Especially since bincode does not support "complicated" data in the sense that deserialize_any is unsupported (bincode-org/bincode#386). This might prevent users from adopting a WebWorker or send them in a deserialization rabbit-hole as their data fails to be passed over the fence with bincode.

Also, is the public/private agent still a thing?

Details about the solution you'd like

I think the most pragmatic solution would be to change the docs to state that bincode is merely the default and point to the Fibonacci example that already uses postcard instead of bincode. yew-agent's docs itself could also point a bit better to what components dictate the codec (Registrar and Provider).

Additional context

impl Codec for Postcard {

Questionaire (Optional)

  • I'd like to write this documentation
  • I'd like to write this documentation but I'm not sure what's needed
  • I don't have time to add this right now, but maybe later
@FantasyPvP
Copy link

this.
literally have no idea how to use the agents. there is no decent documentation for them anywhere and it makes developing anything that requires that kind of functionality almost impossible.

@TiemenSch
Copy link
Author

While not exactly documentation, I wrote the ratio-reactor crate as an easy to use webworker abstraction. Perhaps the crate and especially the examples are worth taking a look at. https://gitlab.com/ratio-case-os/rust/ratio-reactor

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

No branches or pull requests

2 participants