diff --git a/app/entities/users/page.mdx b/app/entities/users/page.mdx index 8740711..2328cb4 100644 --- a/app/entities/users/page.mdx +++ b/app/entities/users/page.mdx @@ -11,9 +11,72 @@ export const metadata = { - - A new contact was created. - + + The user's avatar. + + + Short description of the user. + + + 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. + + ```typescript + type Field = { + key: ContentFormat; + value: ContentFormat; + } + ``` + + + Alpha-numeric username. Must be unique within the instance. + + 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. + + + 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)). + + ```typescript + type URI = string; + + type PublicKey = { + actor: URI; + public_key: string; + } + ``` + + + If `true`, the user must approve any new followers manually. If `false`, followers are automatically approved. This does not affect federation, and is meant to be used for clients to display correct UI. + + + User consent to be indexed by search engines. If `false`, the user's profile should not be indexed. + + + The user's federation inbox. Refer to the [federation documentation](/federation). + + + The user's federation outbox. Refer to the [federation documentation](/federation). + + + User's followers. URI must resolve to a [Collection](/structures/collections) of [User](/entities/users) entities. + + + Users that the user follows. URI must resolve to a [Collection](/structures/collections) of [User](/entities/users) entities. + + + User's likes. URI must resolve to a [Collection](/structures/collections) of [Like](/entities/likes) entities. + + + User's dislikes. URI must resolve to a [Collection](/structures/collections) of [Dislike](/entities/dislikes) entities. + + + [Notes](/entities/notes) that the user wants to feature (also known as "pin") on their profile. URI must resolve to a [Collection](/structures/collections) of [Note](/entities/notes) entities. + @@ -26,7 +89,7 @@ export const metadata = { "uri": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771", "created_at": "2024-04-09T01:38:51.743Z", "avatar": { // [!code focus:100] - "application/octet-stream": { + "image/png": { "content": "https://avatars.githubusercontent.com/u/30842467?v=4" } }, diff --git a/app/page.mdx b/app/page.mdx index a49f846..3cb16f8 100644 --- a/app/page.mdx +++ b/app/page.mdx @@ -20,8 +20,8 @@ export const sections = [ The Lysand Protocol is designed as a communication medium for federated applications, leveraging the HTTP stack. Its simplicity ensures ease of implementation and comprehension. {{ className: 'lead' }}
-