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

Update how-to GIFs #550

Merged
merged 2 commits into from
Dec 7, 2023
Merged

Update how-to GIFs #550

merged 2 commits into from
Dec 7, 2023

Conversation

SteveMicroNova
Copy link
Contributor

Move contents of docs/imgs/app_demos to docs/imgs/app_demos/old

Add new GIFs to docs/imgs/app_demos featuring webapp2

Replace all references to old GIFs with references to new GIFs

@SteveMicroNova
Copy link
Contributor Author

There isn't a real way to test this I don't think, if it isn't sized properly we'll just have to use the gif resizer script I found while searching for all references to ".gif" in this repo

@SteveMicroNova SteveMicroNova linked an issue Dec 4, 2023 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Dec 4, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (725ccf0) 51.52% compared to head (0f92f9f) 51.52%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #550   +/-   ##
========================================
  Coverage    51.52%   51.52%           
========================================
  Files           23       23           
  Lines         5624     5624           
========================================
  Hits          2898     2898           
  Misses        2726     2726           
Flag Coverage Δ
unittests 51.52% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@rtertiaer rtertiaer left a comment

Choose a reason for hiding this comment

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

I'd much prefer the old gifs simply get removed. They'll still be in the git history, but otherwise they serve no documentation purposes for the currently living version of the webapp - they only serve to take up logical and digital space.

wrt image sizes, all the old gifs are much much smaller - the largest is 1.3M, and the average is about 300K. we definitely need to aim for a similar size for these image; it's important for folks on less than stellar connections (think LTE modems) that these load quickly, and for example Google considers how responsive a website loads (ie how reasonable its images are sized) when recommending web content. Google recommends this resource for optimising images; I'd totally be game for moving to a nice embedded video format to keep these sizes small, especially since they're very well supported in 2023.

@SteveMicroNova
Copy link
Contributor Author

Ready for review again
WEB_APP.md will need some special attention for wording/phrasing, this is getting more to the realm of writer editing rather than strictly programming review

Copy link
Contributor

@rtertiaer rtertiaer left a comment

Choose a reason for hiding this comment

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

why's the "gif creation process" doc being deleted? it doesn't seem like there's a replacement document.

@SteveMicroNova
Copy link
Contributor Author

why's the "gif creation process" doc being deleted? it doesn't seem like there's a replacement document.

Fixed

Copy link
Contributor

@rtertiaer rtertiaer left a comment

Choose a reason for hiding this comment

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

One last thing; can you squash all these commits? otherwise we have these 10mb images hanging out in the git history, but they live for a commit or two, just serving to take up space and bloat our repo.

@linknum23
Copy link
Contributor

linknum23 commented Dec 7, 2023

I would like to suggest a better commit message than Squash... Maybe "Update Web interface how-to GIFs"?

The idea here is for the commit history to be useful, "Squash last 5 commits" does not describe what happened in the commit.

Copy link
Contributor

@linknum23 linknum23 left a comment

Choose a reason for hiding this comment

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

This all looks great. I would suggest fixing a couple of the nitpicks but I think this documents the new interface well.

docs/WEB_APP.md Outdated Show resolved Hide resolved
docs/imgs/app_demos/HOW_TO.md Show resolved Hide resolved
@SteveMicroNova SteveMicroNova dismissed rtertiaer’s stale review December 7, 2023 20:13

Dismissing because I believe the concerns have been accounted for and the outstanding "changes requested" is blocking merge post-approval

@SteveMicroNova SteveMicroNova merged commit f1c3043 into develop Dec 7, 2023
2 checks passed
@SteveMicroNova SteveMicroNova deleted the GifUpdate branch December 7, 2023 20:14
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.

Update GIFs used to demonstrate Web UI
4 participants