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

Index of Examples Fixes and Changes #3186

Merged
merged 8 commits into from Mar 28, 2023

Conversation

Jaffa-Cakes
Copy link
Contributor

@Jaffa-Cakes Jaffa-Cakes commented Mar 27, 2023

Description

This PR fixes and changes the following in the README.md of the examples directory:

  • Added all communication examples to index
  • Added ssr_router to index
  • Added function_router to index
  • Reordered the index into alphabetical order to match the examples directory
  • Unified full-stop usage for index descriptions
  • Minor heading and text tweaks
  • Improved index legend

More explicit breakdowns are available in each individual commit.

Checklist

  • I have reviewed my own code

The checklist item for additional tests has been omitted as they are not necessary in this situation.

- Added all communication examples
- Reordered into alphabetical order to match the examples directory
- Added `ssr_router` to the list
- Added `function_router` to the list
- Unified full stop usage
@Jaffa-Cakes Jaffa-Cakes changed the title Index of Examples Fixes Index of Examples Fixes and Changes Mar 27, 2023
@github-actions
Copy link

github-actions bot commented Mar 27, 2023

Size Comparison

examples master (KB) pull request (KB) diff (KB) diff (%)
async_clock 99.081 99.081 0 0.000%
boids 169.249 169.249 0 0.000%
communication_child_to_parent 90.012 90.012 0 0.000%
communication_grandchild_with_grandparent 103.549 103.549 0 0.000%
communication_grandparent_to_grandchild 99.569 99.569 0 0.000%
communication_parent_to_child 87.264 87.264 0 0.000%
contexts 105.854 105.854 0 0.000%
counter 85.229 85.229 0 0.000%
counter_functional 85.414 85.414 0 0.000%
dyn_create_destroy_apps 88.012 88.012 0 0.000%
file_upload 99.314 99.314 0 0.000%
function_memory_game 162.304 162.304 0 0.000%
function_router 335.514 335.514 0 0.000%
function_todomvc 157.921 157.921 0 0.000%
futures 222.993 222.993 0 0.000%
game_of_life 105.891 105.891 0 0.000%
immutable 179.303 179.303 0 0.000%
inner_html 81.640 81.640 0 0.000%
js_callback 110.185 110.185 0 0.000%
keyed_list 197.180 197.180 0 0.000%
mount_point 84.809 84.809 0 0.000%
nested_list 111.349 111.349 0 0.000%
node_refs 92.479 92.479 0 0.000%
password_strength 1534.787 1534.787 0 0.000%
portals 95.625 95.625 0 0.000%
router 307.044 307.044 0 0.000%
simple_ssr 140.469 140.469 0 0.000%
ssr_router 372.244 372.244 0 0.000%
suspense 107.376 107.376 0 0.000%
timer 88.108 88.108 0 0.000%
todomvc 140.028 140.028 0 0.000%
two_apps 85.832 85.832 0 0.000%
web_worker_fib 149.964 149.964 0 0.000%
webgl 84.349 84.349 0 0.000%

✅ None of the examples has changed their size significantly.

Copy link
Member

@WorldSEnder WorldSEnder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've taken the liberty to check for spelling of other descriptions and add some suggestions for improvements there. Might as well. Thanks for the contribution!

examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
Jaffa-Cakes and others added 3 commits March 27, 2023 16:31
Co-authored-by: WorldSEnder <WorldSEnder@users.noreply.github.com>
Co-Authored-By: WorldSEnder <WorldSEnder@users.noreply.github.com>
@Jaffa-Cakes
Copy link
Contributor Author

@WorldSEnder

I've taken the liberty to check for spelling of other descriptions and add some suggestions for improvements there. Might as well. Thanks for the contribution!

I've added the changes you mentioned, ready for your review again. 😄

Co-Authored-By: WorldSEnder <WorldSEnder@users.noreply.github.com>
Copy link
Member

@WorldSEnder WorldSEnder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now! If some other reviewer has suggestions for the legend of "S", "F" and "SF", I'm open to ideas ^^

Copy link
Member

@futursolo futursolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the pull request!

@futursolo futursolo merged commit 8c9d942 into yewstack:master Mar 28, 2023
6 of 7 checks passed
@Jaffa-Cakes Jaffa-Cakes deleted the examples-readme branch March 28, 2023 10:53
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

3 participants