Skip to content

Conversation

waliilaw
Copy link

@waliilaw waliilaw commented Sep 3, 2025

image optimization and management improvements

this pull request focuses on optimizing the documentation's image assets and implementing better image management practices.

changes made

1. cleanup of unused images

  • moved 44 unused images to a backup folder under /website/static/docs/assets/backup/
  • mainly affected welcome-pages directory images
  • preserved images for potential future use
  • reduces repository size and maintenance overhead

2. external image localization

  • downloaded and stored external images locally
  • organized into topic-specific folders:
    • web3-apps/: aurora documentation images
    • chain-abstraction/: near blog images
    • smart-contracts/: medium article diagrams
    • tutorials/templates/: preview images
  • updated markdown references to use local paths
  • improves loading reliability and content ownership

3. maintenance tools

added three python scripts for ongoing maintenance:

  • find_external_images.py: detects external image urls in markdown files
  • cleanup_unused_images.py: identifies and moves unused images to backup
  • localize_external_images.py: downloads external images and updates references

benefits

  • faster page loads: all images served from our domain
  • reliability: no dependency on external image hosts
  • maintainability: organized folder structure
  • future-proof: tools for ongoing maintenance
  • disk space: unused images archived but preserved

testing

  • verified all image moves with backup copies
  • checked all local image references work
  • ensured documentation builds successfully

hope this helps :)

1. remove 44 unused images to backup folder
   - mostly from welcome-pages directory
   - created backup in assets/backup/

2. localize external images
   - moved aurora doc images locally
   - moved near blog images locally
   - moved medium images locally
   - moved imgur preview images locally
   - created organized folders by topic

3. add image management scripts
   - find_external_images.py to detect external urls
   - cleanup_unused_images.py for removing unused
   - localize_external_images.py for downloading
@waliilaw
Copy link
Author

waliilaw commented Sep 3, 2025

hey @bucanero just wanted to flag this pr for you. it cleans up unused images, localizes external ones, and adds some scripts for easier maintenance going forward. everything builds fine on my end, but would be great if you could take a look, test, and merge when you get a chance

Copy link
Collaborator

@gagdiez gagdiez left a comment

Choose a reason for hiding this comment

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

hi @waliilaw thanks for the PR, I like the idea of bringing most images to the repo, but would prefer to avoid images as large as 1MB

Could be bring down the quality of those to a reasonable size (lets say 100kb?)

@waliilaw
Copy link
Author

waliilaw commented Oct 2, 2025

got it 👍 thanks for the feedback. i’ll optimize the larger images and bring them down under ~100kb, then update the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: NEW❗
Development

Successfully merging this pull request may close these issues.

3 participants