docs: add avatar drivers guide for User extender #498
Conversation
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
Documents the new avatar driver system introduced in flarum/framework#4130. Includes implementation guide, examples, and admin configuration.
Documents the new avatar driver system introduced in flarum/framework#4130. Includes implementation guide, examples, and admin configuration.
- 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
9 tasks
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the avatar driver system introduced in flarum/framework#4130. The documentation enables extension developers to create custom avatar providers as alternatives to Gravatar or to integrate with external services like Discord, GitHub, and Steam.
- Documents the avatar driver interface and fallback chain
- Provides complete code examples for implementing and registering custom avatar drivers
- Explains automatic admin panel integration without requiring additional frontend code
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| sidebars.js | Adds the avatars documentation to the Advanced Guides section in alphabetical order |
| docs/extend/avatars.md | Comprehensive new documentation covering avatar driver implementation, registration, and admin configuration with practical Discord example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
datlechin
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
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).