From 050d715793507f3fc5ee726e0c960236f04a4850 Mon Sep 17 00:00:00 2001 From: Jersey Date: Sun, 29 Sep 2024 13:03:03 -0400 Subject: [PATCH] merge #16 Co-authored-by: Finley <161162126+Finley224@users.noreply.github.com> --- .github/workflows/lint.yml | 2 +- .vitepress/config.mts | 5 +- .vitepress/sidebar.mts | 22 +++++- .vitepress/theme/custom.css | 4 +- deno.json | 2 +- docs/api-client/index.md | 10 +-- docs/api/cloudlink/commands/authpswd.md | 6 ++ docs/api/cloudlink/intro.md | 16 ++--- docs/api/cloudlink/packets/delete_post.md | 12 ++++ docs/api/cloudlink/packets/typing.md | 13 ++++ docs/api/cloudlink/packets/ulist.md | 11 +++ docs/public/api/rest.html | 88 ++++++++++++----------- 12 files changed, 126 insertions(+), 65 deletions(-) create mode 100644 docs/api/cloudlink/packets/delete_post.md create mode 100644 docs/api/cloudlink/packets/typing.md create mode 100644 docs/api/cloudlink/packets/ulist.md diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 55561f4..ef52cf7 100644 --- a/.github/workflows/lint.yml +++ b/.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 diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 57b81b6..d982616 100644 --- a/.vitepress/config.mts +++ b/.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', }, ], }, diff --git a/.vitepress/sidebar.mts b/.vitepress/sidebar.mts index 6a841f8..20c5d25 100644 --- a/.vitepress/sidebar.mts +++ b/.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', + }, + ], }, ], }, diff --git a/.vitepress/theme/custom.css b/.vitepress/theme/custom.css index e830c36..98691ce 100644 --- a/.vitepress/theme/custom.css +++ b/.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; } diff --git a/deno.json b/deno.json index 3935e48..a4540d1 100644 --- a/deno.json +++ b/deno.json @@ -28,6 +28,6 @@ }, "exclude": [".vitepress/cache", ".vitepress/dist"] }, - "nodeModulesDir": true, + "nodeModulesDir": "auto", "lock": false } diff --git a/docs/api-client/index.md b/docs/api-client/index.md index 6128e71..eac5914 100644 --- a/docs/api-client/index.md +++ b/docs/api-client/index.md @@ -33,11 +33,11 @@ deno add @meower/api-client ```html [browsers] ``` diff --git a/docs/api/cloudlink/commands/authpswd.md b/docs/api/cloudlink/commands/authpswd.md index b1382d4..d3b3ca7 100644 --- a/docs/api/cloudlink/commands/authpswd.md +++ b/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 diff --git a/docs/api/cloudlink/intro.md b/docs/api/cloudlink/intro.md index f66bebd..65df23b 100644 --- a/docs/api/cloudlink/intro.md +++ b/docs/api/cloudlink/intro.md @@ -1,11 +1,11 @@ # Intro - +This section describes the Cloudlink API found at +based on its behavior and source code found at +. -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) + + diff --git a/docs/api/cloudlink/packets/delete_post.md b/docs/api/cloudlink/packets/delete_post.md new file mode 100644 index 0000000..00e1bee --- /dev/null +++ b/docs/api/cloudlink/packets/delete_post.md @@ -0,0 +1,12 @@ +# `delete_post` + +This packet is sent when a post is deleted. + +## Payload + + +| 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. | + diff --git a/docs/api/cloudlink/packets/typing.md b/docs/api/cloudlink/packets/typing.md new file mode 100644 index 0000000..615a111 --- /dev/null +++ b/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 + + +| 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. | + diff --git a/docs/api/cloudlink/packets/ulist.md b/docs/api/cloudlink/packets/ulist.md new file mode 100644 index 0000000..049dae4 --- /dev/null +++ b/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; +``` diff --git a/docs/public/api/rest.html b/docs/public/api/rest.html index 502c1fe..745943c 100644 --- a/docs/public/api/rest.html +++ b/docs/public/api/rest.html @@ -1,50 +1,52 @@ - - - - Meower REST API docs - - - - - - - + #mosaic-provider-react-aria-0-1 + > div + > div + > div + > div.sl-flex + > div.sl-flex + > a { + display: none; + } + + + + +