diff --git a/app/entities/group/page.mdx b/app/entities/group/page.mdx new file mode 100644 index 0000000..ec9e4cc --- /dev/null +++ b/app/entities/group/page.mdx @@ -0,0 +1,58 @@ +export const metadata = { + title: 'Groups', + description: 'Groups are a way to organize users and notes into communities.' +} + +# Groups + +Groups are a way to organize users and notes into communities. They can be used for any purpose, such as forums, blogs, image galleries, video sharing, audio sharing, and messaging. They are similar to Discord's channels or Matrix's rooms. {{ className: 'lead' }} + +Refer to [Note](/entities/note#entity-definition)'s `group` property for how notes can be associated with groups. + +## Entity Definition + + + + + + Group name/title. + + Text only (`text/plain`, `text/html`, etc). + + + Short description of the group's contents and purpose. + + Text only (`text/plain`, `text/html`, etc). + + + URI of the group's members list. [Collection](/structures/collection) of [Users](/entities/user). + + + URI of the group's associated notes. [Collection](/structures/collection) of [Notes](/entities/note). + + + + + + + ```jsonc {{ title: "Example Group" }} + { + "type": "Group", + "id": "ed480922-b095-4f09-9da5-c995be8f5960", + "uri": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960", + "name": { + "text/html": { + "content": "The Woozy fan club" + } + }, + "description": { + "text/plain": { + "content": "A group for fans of the Woozy emoji." + } + }, + "members": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960/members", + } + ``` + + + \ No newline at end of file diff --git a/app/entities/note/page.mdx b/app/entities/note/page.mdx index dd5908a..4b9c311 100644 --- a/app/entities/note/page.mdx +++ b/app/entities/note/page.mdx @@ -51,7 +51,7 @@ Notes represent a piece of content on a Versia instance. They can be posted by [ ``` - URI of a [Group](/groups) that the note is only visible in, or one of the following strings: + URI of a [Group](/entities/group) that the note is only visible in, or one of the following strings: - `public`: The note is visible to anyone. - `followers`: The note is visible only to the author's followers. diff --git a/components/Navigation.tsx b/components/Navigation.tsx index 237cb9b..963106a 100644 --- a/components/Navigation.tsx +++ b/components/Navigation.tsx @@ -276,6 +276,7 @@ export const navigation: NavGroup[] = [ { title: "Follow", href: "/entities/follow" }, { title: "FollowAccept", href: "/entities/follow-accept" }, { title: "FollowReject", href: "/entities/follow-reject" }, + { title: "Group", href: "/entities/group" }, { title: "Notes", href: "/entities/note" }, { title: "InstanceMetadata", href: "/entities/instance-metadata" }, { title: "Unfollow", href: "/entities/unfollow" },