Add Documentation #2

Droid00000 · 2025-02-02T22:25:07Z

Summary

So, this is my attempt at documentation. I mainly attempted to reference the docs for LavaSrc and the SponsorBlock plugin. If there's anything that's incorrect, please feel free to let me know. I'll attempt to correct it.

topi314

not bad for a start, but I prefer to have tables with field descriptions, feel free to link to https://lavalink.dev for common types

README.md

topi314 · 2025-02-02T22:46:54Z

README.md

+> This plugin is compatible with Lavalink version four and higher.
+
+A plugin that adds a queue system for [Lavalink](https://github.com/lavalink-devs/Lavalink).


A simple queue plugin for LavaLink with a REST API.

README.md

topi314 · 2025-02-02T22:51:59Z

README.md

+* `repeat`
+* `track`


this should be a table with descriptions

for my preferred format see: https://github.com/topi314/LavaSrc#playlist-types

README.md

topi314 · 2025-02-02T22:53:04Z

README.md

+
+```json5
+{
+  "type": "normal",
+  "tracks": [
+    {
+      "encoded": "...",
+      "info": "{}",
+      "pluginInfo": "{}",
+      "userData": "{}"
+    }
+  ]
+}
+```


responses should have a table and then a <details> with a json example

Co-authored-by: Toπ <git@topi.wtf>

Droid00000 · 2025-02-03T02:13:22Z

Alright, I've added tables and descriptors for types and their custom objects, as well as wrapped the JSON examples in <details>. I wasn't sure if I needed to add examples for every response since most of them are just standard Lavalink objects. But, I can do that as well.

topi314 · 2025-02-03T07:52:00Z

README.md

+* [API](#api)
+* [Get Queue](#get-queue)
+* [Update Queue](#update-queue)
+* [Next Queue Track](#next-queue-track)
+* [Previous Queue Track](#previous-queue-track)
+* [Add Queue Track](#add-queue-tracks)
+* [Update Queue Track](#update-queue-tracks)
+* [Get Queue Track](#get-queue-track)
+* [Add Queue Track](#add-queue-track)
+* [Delete Queue Track(s)](#delete-queue-track(s))
+* [Move Queue Track](#move-queue-track)
+* [Get Queue History](#get-queue-history)
+* [Get Queue History Track](#get-queue-history-track)


if something is a sub header it should be indented
the events are missing in here too

topi314 · 2025-02-03T07:53:16Z

README.md

+---
+
+### Queue Types


in 98c97f9 i renamed queue type to queue mode

topi314 · 2025-02-03T07:53:42Z

README.md

+
+| Type                                                                          | Description                                               |
+|-------------------------------------------------------------------------------|-----------------------------------------------------------|
+| [track](https://lavalink.dev/api/rest.html#track)                             | A track object returned in API responses.                 |
+| [update_player_track](https://lavalink.dev/api/rest.html#update-player-track) | An update player track that can be sent in API requests.  |


I would just link where they are actually used to the lavalink docs

topi314 · 2025-02-03T07:55:41Z

README.md

+|--------|--------|-----------------------------------------|
+| type   | string | the type of queue.                      |
+| tracks | array  | An array of track objects in the queue. |


here you should link to the lavalink docs track object https://lavalink.dev/api/rest.html#track
type should be array of [Track](https://lavalink.dev/api/rest.html#track) objects

topi314 · 2025-02-03T07:56:04Z

README.md

+| Field  | Type   | Description                             |
+|--------|--------|-----------------------------------------|
+| type   | string | the type of queue.                      |


renamed to mode and you should link to the queue mode types here

topi314 · 2025-02-03T07:56:59Z

README.md

+      "encoded": "...",
+      "info": "{}",
+      "pluginInfo": "{}",


pluginInfo isnt a string

topi314 · 2025-02-03T07:57:11Z

README.md

+      "info": "{}",
+      "pluginInfo": "{}",
+      "userData": "{}"


userData isnt a string

topi314 · 2025-02-03T07:57:44Z

README.md

+
+The plugin provides a REST API to add, remove, and update tracks in the queue.


this should be above the common types

topi314 · 2025-02-03T07:59:11Z

README.md

+<summary>Example Payload</summary>
+
+```json5
+{
+  "type": "normal",
+  "tracks": [
+    {
+      "encoded":"QAAAjQIAJVJpY2sgQXN0bGV5IC0gTmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXAADlJpY2tBc3RsZXlWRVZPAAAAAAADPCAAC2RRd"
+    }
+  ]
+}
+```
+</details>


topi314 · 2025-02-03T08:00:05Z

README.md

+### Get Queue Track
+
+Gets a track from the queue at the specified index. Response is a track object.


response should be listed below and link to the lavalink docs

Droid00000 · 2025-02-03T21:26:12Z

Alright, I've tried to make the changes you've asked.

topi314 · 2025-02-03T21:44:36Z

if you solved something feel free to mark it as resolved

topi314

maybe the following structure would fit better:

Installation
API
- Common Types
- Endpoints
  - ...
- Events
  - ...

README.md

topi314 · 2025-02-03T21:47:23Z

README.md

+|---------------------------------------------------|-----------------------------------------------------------------------------------------------|
+| [track](https://lavalink.dev/api/rest.html#track) | A track object returned in API responses.                                                     |
+| update_queue                                    | An array of [update player track](https://lavalink.dev/api/rest#update-player-track) objects.   |


this needs a field column

topi314 · 2025-02-03T21:47:52Z

README.md

+{
+  [
+    {
+      "encoded": "QAAAjQIAJVJpY2sgQXN0bGV5IC0gTmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXAADlJpY2tBc3RsZXlWRVZPAAAAAAADPCAAC2RRd"
+    }
+  ]
+}
+```


this payload doesn't look correct to me

topi314 · 2025-02-03T21:48:39Z

README.md

+```
+
+**Response:** [Queue Object](#queue-object)


no need to make response bold, you should also add linebreaks here

maybe a better example format would be https://github.com/topi314/LavaLyrics#api

How about having a table for each response?

yes, that's how I usually do it, if a payload is returned by multiple endpoints you can create a common type

Droid00000 · 2025-02-28T22:44:19Z

Update: 👋 I’m still around to work on this. Ideally, I’ll be able to apply your feedback sometime next week. Apologies for the delay

Droid00000 added 3 commits February 2, 2025 17:24

Add Documentation

30d126f

Fix Incorrect Verbs

a706323

Fix Incorrect URL Path

8389b71

topi314 requested changes Feb 2, 2025

View reviewed changes

Droid00000 and others added 11 commits February 2, 2025 18:12

Apply suggestions from code review

8919e08

Co-authored-by: Toπ <git@topi.wtf>

Queue Types Table

7273604

Update Heading

6367486

Add Tables

5dae2cd

Add Endpoints in Summary

8f2225f

Fix Formatting

f64049a

Remove # from heading

af02b10

Add Backticks

532629a

Grammatical Fixes

70488d2

Add Extra Divider

a767fe8

Add Optional Fields Notice

6f2ad7e

Droid00000 requested a review from topi314 February 3, 2025 02:13

topi314 requested changes Feb 3, 2025

View reviewed changes

Droid00000 added 7 commits February 3, 2025 15:45

fix queue naming, add table for payloads

82c5f36

Format Tables

da0aefb

Document Return Types

b15c715

Clarify Request Body

be53b5a

Remove Divider

de4eb30

Remove unnessecary backticks

0ea7884

move API above types

880b14e

Droid00000 requested a review from topi314 February 3, 2025 21:26

remove divider

0b4f427

topi314 requested changes Feb 3, 2025

View reviewed changes

Droid00000 added 2 commits February 3, 2025 17:09

Remove JSON5 and fix types column

92e0cb4

restructure table

80e45e5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Documentation #2

Add Documentation #2

Droid00000 commented Feb 2, 2025

topi314 left a comment

topi314 Feb 2, 2025

topi314 Feb 2, 2025

topi314 Feb 2, 2025

topi314 Feb 2, 2025

Droid00000 commented Feb 3, 2025 •

edited

Loading

topi314 Feb 3, 2025

topi314 Feb 3, 2025

topi314 Feb 3, 2025

topi314 Feb 3, 2025

topi314 Feb 3, 2025

topi314 Feb 3, 2025

topi314 Feb 3, 2025

topi314 Feb 3, 2025

topi314 Feb 3, 2025

topi314 Feb 3, 2025

Droid00000 commented Feb 3, 2025

topi314 commented Feb 3, 2025

topi314 left a comment

topi314 Feb 3, 2025

topi314 Feb 3, 2025

topi314 Feb 3, 2025 •

edited

Loading

Droid00000 Feb 3, 2025

topi314 Feb 4, 2025

Droid00000 commented Feb 28, 2025

		> This plugin is compatible with Lavalink version four and higher.

		A plugin that adds a queue system for [Lavalink](https://github.com/lavalink-devs/Lavalink).


		The plugin provides a REST API to add, remove, and update tracks in the queue.

		### Get Queue Track

		Gets a track from the queue at the specified index. Response is a track object.

		```

		Response: [Queue Object](#queue-object)

Add Documentation #2

Are you sure you want to change the base?

Add Documentation #2

Conversation

Droid00000 commented Feb 2, 2025

Summary

topi314 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Droid00000 commented Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Droid00000 commented Feb 3, 2025

topi314 commented Feb 3, 2025

topi314 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

topi314 Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Droid00000 commented Feb 28, 2025

Droid00000 commented Feb 3, 2025 •

edited

Loading

topi314 Feb 3, 2025 •

edited

Loading