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

Clean-up old images, compress wolf-sheep image, remove version switch artifact #2717

Merged
merged 3 commits into from
Mar 13, 2025

Conversation

EwoutH
Copy link
Member

@EwoutH EwoutH commented Mar 13, 2025

This PR cleans up the docs folder by:

  • Removing old, unused images from docs/images/tutorial and docs/tutorials/files
  • Compress the docs/images/wolf_sheep.png from 715 KB to 163 KB (77% reduction)
  • Remove version switch artifact.
    (clean-up after Readthedocs: Add version switch and update URL #2324 removal)

In total this removes a little over 2 MB from our repo. It should also make our distribution significantly smaller, which addresses the issue @martibosch reported when reviewing the JOSS paper (openjournals/joss-reviews#7668 (comment), part of #2666).

Additional, the smaller wolf-sheep image should let our docs main page load faster and use less data.

EwoutH added 3 commits March 13, 2025 14:31
From 715 KB to 163 KB (77% reduction)
This was added for the version switch, not needed anymore
@EwoutH EwoutH added the docs Release notes label label Mar 13, 2025
@EwoutH EwoutH requested a review from quaquel March 13, 2025 13:40
@EwoutH EwoutH mentioned this pull request Mar 13, 2025
40 tasks
@EwoutH
Copy link
Member Author

EwoutH commented Mar 13, 2025

In total, should reduce our mesa.tar.gz distribution from 3.2 to 1.2 MB.

@EwoutH EwoutH added the backport-candidate PRs we might want to backport to an earlier branch label Mar 13, 2025
Copy link
Member

@tpike3 tpike3 left a comment

Choose a reason for hiding this comment

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

LGTM

@EwoutH EwoutH merged commit b60f75e into projectmesa:main Mar 13, 2025
11 checks passed
EwoutH added a commit that referenced this pull request Mar 13, 2025
… artifact (#2717)

This PR cleans up the docs folder by:
- Removing old, unused images from `docs/images/tutorial` and `docs/tutorials/files`
- Compress the `docs/images/wolf_sheep.png` from 715 KB to 163 KB (77% reduction)
- Remove version switch artifact

In total this removes a little over 2 MB from our repo. It should also make our distribution significantly smaller (3.2 to 1.2 MB).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-candidate PRs we might want to backport to an earlier branch docs Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants