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

Confusing Router documentation (versions mismatch) #1951

Closed
2 of 8 tasks
realcr opened this issue Jul 14, 2021 · 0 comments · Fixed by #1952
Closed
2 of 8 tasks

Confusing Router documentation (versions mismatch) #1951

realcr opened this issue Jul 14, 2021 · 0 comments · Fixed by #1952

Comments

@realcr
Copy link

realcr commented Jul 14, 2021

This is about:

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

Problem

Following the stable documentation (https://yew.rs/, 0.18.0), the documentation proposed to check the router example, which links to the master branch of the project (https://github.com/yewstack/yew/tree/master/examples/router)

Following this link, I attempted to write my own web app using a router, but I could not compile it.
Eventually I figured out that I am using version yew of 0.18.0, which is outdated with respect to the router example seen on master.

As a yew newbie it took me a long time to understand that the code doesn't compile due to versions mismatch, and not because I am doing something wrong.

Details about the solution you'd like (Optional)

A possible workarounds are to pin the router example link to a specific commit.
Another possible solution would be to have a new yew release (:

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant