From cf4f4ee727625c204990c60a99c15a9a66959b30 Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Mon, 22 Jul 2024 19:03:27 +0200 Subject: [PATCH] docs: :memo: Complete more User info --- app/entities/users/page.mdx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/app/entities/users/page.mdx b/app/entities/users/page.mdx index 2328cb4..39b7594 100644 --- a/app/entities/users/page.mdx +++ b/app/entities/users/page.mdx @@ -5,6 +5,8 @@ export const metadata = { # Users +The `User` entity represents an account on a Lysand instance. Users can post [Notes](/entities/notes), follow other users, and interact with content. Users are identified by their `id` property, which is unique within the instance. {{ className: 'lead' }} + ## Entity Definition @@ -12,16 +14,16 @@ export const metadata = { - The user's avatar. + The user's avatar. Must be an image format (`image/*`). - Short description of the user. + Short description of the user. Must be text format (`text/*`). Display name, as shown to other users. May contain emojis and any Unicode character. - Custom key/value pairs. For example, metadata like socials or pronouns. + Custom key/value pairs. For example, metadata like socials or pronouns. Must be text format (`text/*`). ```typescript type Field = { @@ -31,12 +33,12 @@ export const metadata = { ``` - Alpha-numeric username. Must be unique within the instance. + Alpha-numeric username. Must be unique within the instance. **Must** be treated as changeable by the user. Can only contain the following characters: `a-z` (lowercase), `0-9`, `_` and `-`. Should be limited to reasonable lengths. - A header image for the user's profile. Also known as a cover photo or a banner. + A header image for the user's profile. Also known as a cover photo or a banner. Must be an image format (`image/*`). The user's public key. Must follow the [Lysand Public Key](/signatures) format. `actor` may be a URI to another user's profile, in which case this key may allow the user to act on behalf of the other user (see [delegation](/delegation)).