Skip to content

docs: document HiDPI avatar srcset variants - #523

Merged
imorland merged 1 commit into
mainfrom
im/hidpi-avatar-srcset
Apr 11, 2026
Merged

docs: document HiDPI avatar srcset variants#523
imorland merged 1 commit into
mainfrom
im/hidpi-avatar-srcset

Conversation

@imorland

Copy link
Copy Markdown
Member

Documents the HiDPI avatar srcset feature introduced in flarum/framework#4555.

avatars.md

  • Updated DriverInterface section to document both avatarUrl() and the new avatarSrcset() method, with a full example showing density-descriptor srcset strings
  • New section: HiDPI Variants for Uploaded Avatars — explains the @2x/@3x filename convention, the no-upscaling rule, and how the Avatar component handles srcset automatically
  • New section: Providing HiDPI Avatars via OAuth Registration — documents provideAvatar2x() and provideAvatar3x() on the Registration object

update-2_0.md

  • Added a Notable bullet summarising the HiDPI changes and linking to the avatar driver docs

@imorland
imorland marked this pull request as ready for review April 11, 2026 15:52
@imorland
imorland merged commit 740a9fb into main Apr 11, 2026
1 check passed
@imorland
imorland deleted the im/hidpi-avatar-srcset branch April 11, 2026 16:03
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.

1 participant