Yew: The examples are slightly bit rotten :)

[numerodix]

Problem
I'm perusing the examples (and there are many!) finding that it's a bit hard to get them to run. A number of examples are missing a README that explains what is being demonstrated, and some are missing an appropriate index.html to easily run them (or the index.html inside static/ doesn't match the code properly etc). The ones that do are missing style sheets, which makes them appear "broken" (in the sense that they don't look the way the author probably intended?) and don't demonstrate their use case effectively.

This is all based on running ./build.sh <example_name> as instructed by the README.

Environment:

• Yew version: master
• Rust version: rustc 1.45.0-nightly (5fd2f06e9 2020-05-31)

Questionnaire

• [x] I'd be happy to fix some of them (the examples I can figure out myself), but I'd like to know if there are any other plans/efforts for them at this time?

Also: What do you think about adding some stylesheets (eg. bootstrap) to the examples to make them easier to look at?

[jstarry]

@numerodix indeed they are a bit rotten! 👃 🤮

Fixes would be welcome, @ZainlessBrombie started on something quite similar here: https://github.com/yewstack/yew/issues/1016 so it would be nice to see if they have anything to share first before styling it all

In the meantime..

missing a README that explains what is being demonstrated

the index.html inside static/ doesn't match the code properly etc

Fixes for stuff like this would be awesome!

[jstarry]

And by the way, I wouldn't be opposed to combining the micro-examples into a mono-example 😉 Preferably in a single cargo project

[teymour-aldridge]

Should these two issues be combined into a single tracking issue to make things clearer?

[numerodix]

Yeah, they probably should. I opened this issue without knowing about @ZainlessBrombie's initiative. It looks like zainless has bigger plans anyway, so I'm happy to let zainless take care of it.

I was just planning to make some minor fixes to make the examples work in the event that noone else was doing the same.

[teymour-aldridge]

There's a lot of examples, so I'm sure if you want to contribute to them you can!

[ZainlessBrombie]

Hey there! Sorry for being away some time, I had a bit of a tough time but I'm back on track now (Though on a business trip for another week) :)
Just wanted to give y'all a life sign ;)

PS: Really happy about the survey results :relaxed:

[jstarry]

@numerodix feel free to make incremental improvements in the meantime! We can always resolve merge conflicts, not a big deal :)

[numerodix]

Thanks for the encouragement!

I'd like to make some incremental improvements just to get the examples working and make it obvious what they are trying to demonstrate.

[EvanCarroll]

https://github.com/yewstack/docs/issues/105

[EvanCarroll]

Do any of the examples work and demonstrate best practices?

[numerodix]

I'd say about half of them work out of the box (when I first tried a couple of weeks ago). The plan is to make them all work.