The examples are slightly bit rotten :) #1289
Comments
numerodix
changed the title
|
@numerodix indeed they are a bit rotten! 👃 🤮 Fixes would be welcome, @ZainlessBrombie started on something quite similar here: #1016 so it would be nice to see if they have anything to share first before styling it all In the meantime..
Fixes for stuff like this would be awesome! |
|
And by the way, I wouldn't be opposed to combining the micro-examples into a mono-example 😉 Preferably in a single cargo project |
|
Should these two issues be combined into a single tracking issue to make things clearer? |
|
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. |
|
There's a lot of examples, so I'm sure if you want to contribute to them you can! |
|
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) :) PS: Really happy about the survey results |
|
@numerodix feel free to make incremental improvements in the meantime! We can always resolve merge conflicts, not a big deal :) |
|
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. |
|
Do any of the examples work and demonstrate best practices? |
|
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. |
* Update run instructions `python3 -m http.server --directory` flag was added in Python 3.7. Change instructions to cd into static and skip the flag instead - makes it work with earlier Pythons too. * Add visual feedback for button click The minimal example has a button, but clicking it does nothing. This makes it hard to tell whether the example works or not. This adds a label that is update when the button is clicked. * Small improvements to crm example * Add a heading to each scene to make it more obvious what the page is for. * Improve layout of input form by stack the inputs vertically. * Add a little space between entries when displaying the list. * Add a hint to the Description input that Markdown can be used. * Add an explanation to the file_upload example * Clarify purpose of var in fragments example * Improve futures_wp example * Add a second button that demonstrates an unsuccessful fetch. * Render the markdown document (since we're fetching markdown after all). * Remove vague comment that's not really helping. * Improve inner_html example * Include a textual explanation of what the example is doing. * Run cargo fmt * Remove 'static lifetime for constant * Improve suggestion in inner_html example * move markdown.rs to a common crate * add description to common Cargo.toml * PR feedback * PR feedback * remove static lifetime annotation
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:
Questionnaire
Also: What do you think about adding some stylesheets (eg. bootstrap) to the examples to make them easier to look at?
The text was updated successfully, but these errors were encountered: