Closed
Conversation
Documents the new avatar driver system introduced in flarum/framework#4130. Includes implementation guide, examples, and admin configuration.
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for Flarum's avatar driver system, enabling extension developers to create custom avatar providers as alternatives to the built-in Gravatar and default drivers.
Key Changes
- New complete guide for implementing and registering avatar drivers
- Step-by-step examples including Discord and GitHub integration patterns
- Coverage of advanced patterns including dependency injection and conditional logic
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| sidebars.js | Adds avatar-drivers.md to the Advanced Guides section in alphabetical order |
| docs/extend/avatar-drivers.md | New comprehensive guide covering avatar driver implementation, registration, admin configuration, complete examples, advanced patterns, and testing procedures |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Documents the new avatar driver system introduced in flarum/framework#4130. Includes implementation guide, examples, and admin configuration.
datlechin
force-pushed
the
docs/avatar-drivers
branch
from
bcd6874 to
f9df2e7
Compare
- Use more direct, technical language - Remove verbose explanations and marketing-style wording - Simplify code examples with minimal comments - Remove redundant sections - Match tone and word choices from mail.md, filesystem.md, notifications.md - Reduce file length from ~300 to ~75 lines
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the avatar driver system introduced in flarum/framework#4130.
This PR adds comprehensive documentation for extension developers who want to create custom avatar providers (Gravatar alternatives, OAuth-based avatars, external services).
Changes
docs/extend/avatar-drivers.mdRelated
Extend\User->avatarDriver()Preview
The guide covers:
Checklist