Document `image_url` profile field


I noticed the image_url field doesn't seem to be listed in the docs. It might be useful to add it and also describe how the profile fields are used.

Suggested diff below.

Thanks, Aonrud

diff --git a/docs/user_guide.md b/docs/user_guide.md
index 6df4859..3e10057 100644
--- a/docs/user_guide.md
+++ b/docs/user_guide.md
@@ -25,9 +25,10 @@ As these two config items define your ActivityPub handle `@handle@domain`.
 You can tweak your profile by tweaking these items:
- - `name`
- - `summary` (using Markdown)
- - `icon_url`
+ - `name`: The name shown with your profile.
+ - `summary`: The summary or 'bio' part of your profile, written in Markdown.
+ - `icon_url`: Your profile image or avatar.
+ - `image_url`: This provides a 'header' or 'banner' image. Note that it is not shown by the default Microblog.pub templates. It will be used by Mastodon (which uses a 3:1 ratio image) and Pleroma. Pixelfed and Peertube, for example, don't show these images by default.
 Whenever one of these config items is updated, an `Update` activity will be sent to all known servers to update your remote profile.

Assigned to
2 months ago
a month ago
No labels applied.

~tsileo 2 months ago


Yes that makes sense, do you want to try submitting an actual patch here: https://lists.sr.ht/~tsileo/microblog.pub-devel ?

This way you would appear as a contributor. It's up to you let me know (otherwise I can apply this diff manually).


~aonrud 2 months ago

Thanks -- I think it's a minor enough contribution!

That, and I don't have git email set up :) I'm happy for you to make a commit.

~tsileo REPORTED FIXED a month ago

I just pushed the updated documentation.

Thank you!

Register here or Log in to comment, or comment via email.