Skip to content

Documentation & dependency upgrades #228

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

Merged
merged 7 commits into from
Aug 7, 2025

Conversation

jannis-baum
Copy link
Owner

@jannis-baum jannis-baum commented Jul 19, 2025

Close #226

I also upgrade dependencies in this PR because we had some security alerts again, this time as far as I can tell there was nothing that broke. Dependencies with breaking changes were:

  • express where I ran the auto-migration and it didn't change anything
  • GitHub alerts md-it plugin that changed their compilation method but it doesn't seem to affect us

To-dos

  • remove images from repo so at least HEAD is clean

@jannis-baum jannis-baum requested a review from tuurep July 19, 2025 06:42
@jannis-baum jannis-baum force-pushed the issue/226-documentation-dependency-upgrades branch from b823efb to 43b4fdd Compare July 20, 2025 05:35
@tuurep
Copy link
Collaborator

tuurep commented Jul 25, 2025

Tested rendering, nothing broke

gif looks great, though it obviously looks robotic and unnatural

My immediate reaction is that when the header # Automatic syncing is typed, it comes so fast it's jarring and confusing that it's being live-edited :D

Somehow typing the paragraph text is better, but are they even different speeds?

If filesize is very important, it's fine by me, otherwise I might want to slow it just a little bit.

@jannis-baum
Copy link
Owner Author

My immediate reaction is that when the header # Automatic syncing is typed, it comes so fast it's jarring and confusing that it's being live-edited :D

Somehow typing the paragraph text is better, but are they even different speeds?

Same speeds haha

If filesize is very important, it's fine by me, otherwise I might want to slow it just a little bit.

The current one is 3.7MB at 15FPS with 30ms delay between keystrokes. With 40ms at 15FPS it's 3.9MB and looks like this:

showcase-dark

I think anything under 5MB is definitely acceptable. Do you prefer the 40ms? Or how much slower were you thinking?

@tuurep
Copy link
Collaborator

tuurep commented Jul 29, 2025

Yeah I would say I prefer the 40ms over the 30ms.

Maybe we could go with this?

@jannis-baum
Copy link
Owner Author

Made the adjustments!

Also removed the images from the repo, maybe you can adjust your AUR packages so they shallow-clone the repo, i.e.

git clone --depth 1 --branch main https://github.com/jannis-baum/Vivify.git

then there is a real benefit from it ^^ but low priority I guess

Copy link
Collaborator

@tuurep tuurep left a comment

Choose a reason for hiding this comment

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

Right, just realized this needs an approval from me 😄 Gif looks great, I checked once again.

Said this elsewhere but for here as well: the AUR packages do the cloning implicitly (I haven't written a git clone anywhere) plus the source probably isn't kept after building so I'll probably not do anything about that, but if it's ever relevant I'll keep that in mind.

@jannis-baum jannis-baum force-pushed the issue/226-documentation-dependency-upgrades branch from ce99d2f to 76d1641 Compare August 7, 2025 16:03
@jannis-baum jannis-baum force-pushed the issue/226-documentation-dependency-upgrades branch from 76d1641 to 3ce5084 Compare August 7, 2025 16:06
@jannis-baum jannis-baum merged commit 5474b09 into main Aug 7, 2025
7 checks passed
@jannis-baum jannis-baum deleted the issue/226-documentation-dependency-upgrades branch August 7, 2025 16:25
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.

Documentation & dependency upgrades
2 participants