feat: Add new User page

This commit is contained in:
Jesse Wierzbinski 2024-07-22 15:22:18 +02:00
parent e53dc0d9ff
commit bfa63e26a8
No known key found for this signature in database
6 changed files with 89 additions and 3 deletions

0
app/entities/page.mdx Normal file
View file

View file

@ -0,0 +1,81 @@
export const metadata = {
title: 'Users',
description: 'Definition of the User entity',
}
# Users
## Entity Definition
<Row>
<Col>
<Properties>
<Property name="contact.created">
A new contact was created.
</Property>
</Properties>
</Col>
<Col sticky>
```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": "<p>🌸🌸🌸</p>"
},
"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": "<p>Pronouns</p>"
}
},
"value": {
"text/html": {
"content": "<p>It/its</p>"
}
}
}
],
"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"
}
```
</Col>
</Row>

View file

@ -35,7 +35,7 @@ The words **MUST**, **MUST NOT**, **SHOULD**, **SHOULD NOT**, and **MAY** are us
</Note> </Note>
The Lysand Protocol uses the following terms: 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. - **Implementation**: A software application that implements the Lysand Protocol.
- **Instance**: An application deploying an **Implementation**. - **Instance**: An application deploying an **Implementation**.
- Using the same nomenclature, an ActivityPub Implementation would be `Mastodon`, and an Instance would be `mastodon.social`. - Using the same nomenclature, an ActivityPub Implementation would be `Mastodon`, and an Instance would be `mastodon.social`.

View file

@ -86,6 +86,6 @@
"globals": ["Bun"] "globals": ["Bun"]
}, },
"files": { "files": {
"ignore": ["node_modules", ".next", ".output"] "ignore": ["node_modules", ".next", ".output", "out"]
} }
} }

View file

@ -255,6 +255,10 @@ export const navigation: NavGroup[] = [
{ title: "Webhooks", href: "/webhooks" }, { title: "Webhooks", href: "/webhooks" },
], ],
}, },
{
title: "Entities",
links: [{ title: "Users", href: "/entities/users" }],
},
{ {
title: "Resources", title: "Resources",
links: [ links: [

View file

@ -7,7 +7,8 @@
"build": "next build", "build": "next build",
"start": "next start", "start": "next start",
"typecheck": "tsc -p .", "typecheck": "tsc -p .",
"lint": "bunx @biomejs/biome check ." "lint": "bunx @biomejs/biome check .",
"uuid": "bun --print 'crypto.randomUUID()'"
}, },
"browserslist": "defaults, not ie <= 11", "browserslist": "defaults, not ie <= 11",
"dependencies": { "dependencies": {