diff --git a/app/entities/page.mdx b/app/entities/page.mdx new file mode 100644 index 0000000..e69de29 diff --git a/app/entities/users/page.mdx b/app/entities/users/page.mdx new file mode 100644 index 0000000..3b16c29 --- /dev/null +++ b/app/entities/users/page.mdx @@ -0,0 +1,81 @@ +export const metadata = { + title: 'Users', + description: 'Definition of the User entity', +} + +# Users + +## Entity Definition + + + + + + + A new contact was created. + + + + + + + ```jsonc {{ 'title': 'Example User' }} + { + "id": "018ec082-0ae1-761c-b2c5-22275a611771", + "type": "User", + "uri": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771", + "created_at": "2024-04-09T01:38:51.743Z", + // [!code focus:10] + "avatar": { + "application/octet-stream": { + "content": "https://avatars.githubusercontent.com/u/30842467?v=4" + } + }, + "bio": { + "text/html": { + "content": "

🌸🌸🌸

" + }, + "text/plain": { + "content": "🌸🌸🌸" + } + }, + "dislikes": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771/dislikes", + "display_name": "April The Pink (limited Sand Edition)", + "extensions": { + "org.lysand:custom_emojis": { + "emojis": [] + } + }, + "featured": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771/featured", + "fields": [ + { + "key": { + "text/html": { + "content": "

Pronouns

" + } + }, + "value": { + "text/html": { + "content": "

It/its

" + } + } + } + ], + "followers": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771/followers", + "following": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771/following", + "header": null, + "inbox": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771/inbox", + "indexable": false, + "likes": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771/likes", + "manually_approves_followers": false, + "outbox": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771/outbox", + "public_key": { + "actor": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771", + "public_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" + }, + "username": "aprl" + } + ``` + + +
diff --git a/app/page.mdx b/app/page.mdx index 6b5ff98..a49f846 100644 --- a/app/page.mdx +++ b/app/page.mdx @@ -35,7 +35,7 @@ The words **MUST**, **MUST NOT**, **SHOULD**, **SHOULD NOT**, and **MAY** are us The Lysand Protocol uses the following terms: -- **Entity**: A generic term for any JSON object in the protocol, such as an [Actor](./objects/actors), a [Note](./objects/notes), or a [Like](./objects/likes). Entities are uniquely identified by their `id` property. +- **Entity**: A generic term for any JSON object in the protocol, such as an [Actor](./entities/actors), a [Note](./entities/notes), or a [Like](./entities/likes). Entities are uniquely identified by their `id` property. - **Implementation**: A software application that implements the Lysand Protocol. - **Instance**: An application deploying an **Implementation**. - Using the same nomenclature, an ActivityPub Implementation would be `Mastodon`, and an Instance would be `mastodon.social`. diff --git a/biome.json b/biome.json index 4c705e6..2dd531a 100644 --- a/biome.json +++ b/biome.json @@ -86,6 +86,6 @@ "globals": ["Bun"] }, "files": { - "ignore": ["node_modules", ".next", ".output"] + "ignore": ["node_modules", ".next", ".output", "out"] } } diff --git a/components/Navigation.tsx b/components/Navigation.tsx index 6faab10..122ea08 100644 --- a/components/Navigation.tsx +++ b/components/Navigation.tsx @@ -255,6 +255,10 @@ export const navigation: NavGroup[] = [ { title: "Webhooks", href: "/webhooks" }, ], }, + { + title: "Entities", + links: [{ title: "Users", href: "/entities/users" }], + }, { title: "Resources", links: [ diff --git a/package.json b/package.json index 9269c4c..af9cae2 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,8 @@ "build": "next build", "start": "next start", "typecheck": "tsc -p .", - "lint": "bunx @biomejs/biome check ." + "lint": "bunx @biomejs/biome check .", + "uuid": "bun --print 'crypto.randomUUID()'" }, "browserslist": "defaults, not ie <= 11", "dependencies": {