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

Simplified and Uniform Example Instructions #3113

Open
wants to merge 31 commits into
base: master
Choose a base branch
from

Conversation

Jaffa-Cakes
Copy link

@Jaffa-Cakes Jaffa-Cakes commented Feb 3, 2023

Description

Amended the README.md of all examples to ensure they include:

  • Basic running instructions
  • Commands that are meant to be executed from the directory the example is in
  • Simplified wording for running instructions

Amended examples/README.md to comply with example README.md amendments.

Checklist

  • I have reviewed my own code
  • I have added tests

Reasoning

When I was attempting to look through examples to begin using Yew it wasn't always clear how to run them. Some examples required you to run commands in the examples directory and others in their own examples/<example_name> directory.

This PR attempts to make instructions on how to run examples clearer.

- Added `--open` flag
- Removed unnecessary instructions on how to run with `release` profile
- Added `--open` flag
- Removed unnecessary instructions on how to run with `release` profile
- Added `--open` flag
- Removed unnecessary instructions on how to run with `release` profile
- Amended `release` profile instructions
- Added `--open` flag
- Added `--open` flag
- Amended `release` profile notice
- Added `--open` flag
- Amended `release` profile notice
- Added `--open` flag
- Amended `release` profile notice
- Simplified wording
- Removed unnecessary notes
- Changed commands so that they should be executed from the `examples/simple_ssr` directory like every other example
- Removed unnecessary notes
- Changed commands so that they should be executed from the `examples/ssr_router` directory like every other example
- Simplified running instructions
- Moved running instructions to the bottom of each `README.md`
- Added `release` profile notice
- Added `--open` flag
- Removed `--release` flag
@github-actions
Copy link

github-actions bot commented Feb 3, 2023

Size Comparison

examples master (KB) pull request (KB) diff (KB) diff (%)
async_clock 107.872 107.872 0 0.000%
boids 170.762 170.762 0 0.000%
communication_child_to_parent 90.836 90.836 0 0.000%
communication_grandchild_with_grandparent 105.168 105.168 0 0.000%
communication_grandparent_to_grandchild 100.999 100.999 0 0.000%
communication_parent_to_child 87.930 87.930 0 0.000%
contexts 107.703 107.703 0 0.000%
counter 85.732 85.732 0 0.000%
counter_functional 86.043 86.043 0 0.000%
dyn_create_destroy_apps 88.540 88.540 0 0.000%
file_upload 100.192 100.192 0 0.000%
function_memory_game 164.874 164.874 0 0.000%
function_router 349.528 349.528 0 0.000%
function_todomvc 159.861 159.861 0 0.000%
futures 224.479 224.479 0 0.000%
game_of_life 106.485 106.485 0 0.000%
immutable 181.958 181.958 0 0.000%
inner_html 82.120 82.120 0 0.000%
js_callback 112.006 112.006 0 0.000%
keyed_list 196.195 196.195 0 0.000%
mount_point 85.359 85.359 0 0.000%
nested_list 113.390 113.390 0 0.000%
node_refs 93.370 93.370 0 0.000%
password_strength 1548.737 1548.737 0 0.000%
portals 96.562 96.562 0 0.000%
router 319.672 319.672 0 0.000%
simple_ssr 151.031 151.031 0 0.000%
ssr_router 394.710 394.710 0 0.000%
suspense 109.122 109.122 0 0.000%
timer 88.607 88.607 0 0.000%
todomvc 141.094 141.094 0 0.000%
two_apps 86.354 86.354 0 0.000%
web_worker_fib 151.903 151.903 0 0.000%
webgl 84.936 84.936 0 0.000%

None of the examples has changed their size significantly.

@github-actions
Copy link

github-actions bot commented Feb 3, 2023

Benchmark - SSR

Yew Master

Benchmark Round Min (ms) Max (ms) Mean (ms) Standard Deviation
Baseline 10 389.240 425.449 407.168 11.673
Hello World 10 761.344 823.757 803.026 21.292
Function Router 10 2522.289 2723.571 2631.371 79.343
Concurrent Task 10 1009.563 1012.964 1011.444 1.206

Pull Request

Benchmark Round Min (ms) Max (ms) Mean (ms) Standard Deviation
Baseline 10 394.516 419.178 408.164 8.183
Hello World 10 762.763 817.555 794.457 16.029
Function Router 10 2519.477 2713.172 2615.255 77.993
Concurrent Task 10 1008.538 1013.061 1010.277 1.238

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

Successfully merging this pull request may close these issues.

None yet

1 participant