This is an document pattern for associating personal information (e.g. display
names, avatars, bios) with a particular identity (e.g. @suzy.baaa...
).
All of the below are optional, and an identity may have any or all of the below documents specified.
Identity addresses begin with a shortname to make the address easier to
identify, (e.g. suzy
). These shortnames cannot be changed and are always four
characters long, which makes them unsuitable for most names and the fluctuating
nature of identity.
Therefore it is desirable to have a free-form display name which can be changed at any time.
about / displayName
The desired display name as UTF-8 encoded bytes.
It's also fun to have an image to associate with a given identity.
about / avatar.{IMAGE_EXTENSION}
where IMAGE_EXTENSION
must be the common file extension of an image format
(e.g. gif
, jpg
, png
) which allows clients to know how to interpret the
payload data for this document.
The payload should be image data of the format corresponding to the path's
IMAGE_EXTENSION
. The image data should have a 1:1 aspect ratio. Try to make it
a good size, as applications may not display avatars that are too big.
about / bio
The desired biography as UTF-8 encoded bytes. Can be any length, but applications may not display long bios.