merge #16

Co-authored-by: Finley <[email protected]>

.github/workflows/lint.yml

@@ -19,6 +19,6 @@ jobs:
       - uses: actions/checkout@v3
       - uses: denoland/setup-deno@v1
         with:
-          deno-version: v1.44.4
+          deno-version: 2.0.0-rc.7
       - run: deno lint .
     continue-on-error: true

.vitepress/config.mts

@@ -13,8 +13,7 @@ export default defineConfig({
 	title: 'Meower Docs',
 	themeConfig: {
 		editLink: {
-			pattern:
-				'https://github.com/meower-media-co/api-client/edit/main/docs/:path',
+			pattern: 'https://github.com/meower-media/docs/edit/main/docs/:path',
 		},
 		nav: [
 			{ text: 'Home', link: '/' },
@@ -39,7 +38,7 @@ export default defineConfig({
 		socialLinks: [
 			{
 				icon: 'github',
-				link: 'https://github.com/meower-media-co',
+				link: 'https://github.com/meower-media',
 			},
 		],
 	},

.vitepress/sidebar.mts

@@ -21,8 +21,26 @@ export const sidebar: DefaultTheme.SidebarItem[] = [{
 					link: '/api/cloudlink/commands/authpswd',
 				},
 				{
-					text: 'auth packet',
-					link: '/api/cloudlink/packets/auth',
+					text: 'Packets',
+					collapsed: true,
+					items: [
+						{
+							text: 'auth',
+							link: '/api/cloudlink/packets/auth',
+						},
+						{
+							text: 'delete post',
+							link: '/api/cloudlink/packets/delete_post',
+						},
+						{
+							text: 'typing',
+							link: '/api/cloudlink/packets/typing',
+						},
+						{
+							text: 'ulist',
+							link: '/api/cloudlink/packets/ulist',
+						},
+					],
 				},
 			],
 		},

.vitepress/theme/custom.css

@@ -1,4 +1,4 @@
 :root {
-    --vp-c-brand-1: #F28500;
-    --vp-c-brand-2: #F9A535;
+	--vp-c-brand-1: #f28500;
+	--vp-c-brand-2: #f9a535;
 }

deno.json

@@ -28,6 +28,6 @@
 		},
 		"exclude": [".vitepress/cache", ".vitepress/dist"]
 	},
-	"nodeModulesDir": true,
+	"nodeModulesDir": "auto",
 	"lock": false
 }

docs/api-client/index.md

@@ -33,11 +33,11 @@ deno add @meower/api-client
 
 ```html [browsers]
 <script type="importmap">
-    {
-        "imports": {
-            "@meower/api-client": "https://esm.sh/jsr/@meower/api-client@latest"
-        }
-    }
+	{
+		"imports": {
+			"@meower/api-client": "https://esm.sh/jsr/@meower/api-client@latest"
+		}
+	}
 </script>
 ```
 

docs/api/cloudlink/commands/authpswd.md

@@ -1,5 +1,11 @@
 # `authpswd`
 
+:::warning
+
+This page is out of date
+
+:::
+
 This command is used to log into Meower.
 
 ## Request

docs/api/cloudlink/intro.md

@@ -1,11 +1,11 @@
 # Intro
 
-<!--
-  TODO
-  Points to mention:
-    - What Cloudlink is
-    - How to connect to the Cloudlink server
-    - The general request/response shape
--->
+This section describes the Cloudlink API found at <wss://server.meower.org>
+based on its behavior and source code found at
+<https://github.com/meower-media/server>.
 
-This section is out of date.
+Cloudlink uses WebSockets and JSON for responding and recieving information and
+the format used is partially based on Cloudlink's
+[UPL 2.1](https://hackmd.io/@MikeDEV/HJiNYwOfo#Message-format)
+
+<!-- TODO: add more detail here later on -->

docs/api/cloudlink/packets/delete_post.md

@@ -0,0 +1,12 @@
+# `delete_post`
+
+This packet is sent when a post is deleted.
+
+## Payload
+
+<!-- deno-fmt-ignore-start -->
+| Field | Type | Description |
+| - | - | - |
+| chat_id | string | The ID of the chat where the deleted post was. |
+| post_id | string | The ID of the post that was deleted. |
+<!-- deno-fmt-ignore-end -->

docs/api/cloudlink/packets/typing.md

@@ -0,0 +1,13 @@
+# `typing`
+
+This packet is sent when a client sends a typing indicator. These clients will
+send this packet at an interval less than five seconds.
+
+## Payload
+
+<!-- deno-fmt-ignore-start -->
+| Field | Type | Description |
+| - | - | - |
+| chat_id | string | The ID of the chat the user is typing in. |
+| username | string | The username of the user who is typing. |
+<!-- deno-fmt-ignore-end -->

docs/api/cloudlink/packets/ulist.md

@@ -0,0 +1,11 @@
+# `ulist`
+
+This packet provides a string of online users separated by ";"
+
+## Payload
+
+A string of users separated by ";"
+
+```
+user1;user2;user3;
+```

docs/public/api/rest.html

@@ -1,50 +1,52 @@
 <!DOCTYPE html>
 <html lang="en" data-theme="dark">
-  <head>
-    <meta charset="utf-8" />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1, shrink-to-fit=no"
-    />
-    <title>Meower REST API docs</title>
-    <script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
-    <link
-      rel="stylesheet"
-      href="https://unpkg.com/@stoplight/elements/styles.min.css"
-    />
-    <style>
-      body {
-        background-color: #0e131b;
-      }
+	<head>
+		<meta charset="utf-8" />
+		<meta
+			name="viewport"
+			content="width=device-width, initial-scale=1, shrink-to-fit=no"
+		/>
+		<title>Meower REST API docs</title>
+		<script
+			src="https://unpkg.com/@stoplight/elements/web-components.min.js"
+		></script>
+		<link
+			rel="stylesheet"
+			href="https://unpkg.com/@stoplight/elements/styles.min.css"
+		/>
+		<style>
+			body {
+				background-color: #0e131b;
+			}
 
-      ::-webkit-scrollbar {
-        width: 10px;
-      }
+			::-webkit-scrollbar {
+				width: 10px;
+			}
 
-      ::-webkit-scrollbar-track {
-        background: #0e131b;
-      }
+			::-webkit-scrollbar-track {
+				background: #0e131b;
+			}
 
-      ::-webkit-scrollbar-thumb {
-        background: #1f2937;
-      }
+			::-webkit-scrollbar-thumb {
+				background: #1f2937;
+			}
 
-      #mosaic-provider-react-aria-0-1
-        > div
-        > div
-        > div
-        > div.sl-flex
-        > div.sl-flex
-        > a {
-        display: none;
-      }
-    </style>
-  </head>
-  <body>
-    <elements-api
-      apiDescriptionUrl="https://api.meower.org/openapi.json"
-      router="hash"
-      layout="sidebar"
-    />
-  </body>
+			#mosaic-provider-react-aria-0-1
+				> div
+				> div
+				> div
+				> div.sl-flex
+				> div.sl-flex
+				> a {
+				display: none;
+			}
+		</style>
+	</head>
+	<body>
+		<elements-api
+			apiDescriptionUrl="https://api.meower.org/openapi.json"
+			router="hash"
+			layout="sidebar"
+		/>
+	</body>
 </html>