Merge pull request #943 from lavalink-devs/test/docs

lavalink-devs · Aug 15, 2023 · 987b5ca · 987b5ca
2 parents 09795b6 + 1a8bb25
commit 987b5ca
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 20 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -76,6 +76,6 @@ jobs:
         with:
           apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
           accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          projectName: ${{ github.repository }}
+          projectName: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
           directory: site
           gitHubToken: ${{ secrets.GITHUB_TOKEN }}
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -129,7 +129,6 @@ the JDA client takes advantage of JDA's websocket write thread to send OP 4s for
 
 Fields marked with `?` are optional and types marked with `?` are nullable.
 
-
 ## Resuming
 
 What happens after your client disconnects is dependent on whether the session has been configured for resuming.

diff --git a/docs/api/rest.md b/docs/api/rest.md
@@ -88,11 +88,11 @@ GET /v4/sessions/{sessionId}/players
 
 ##### Voice State
 
-| Field      | Type   | Description                                                                                 |
-|------------|--------|---------------------------------------------------------------------------------------------|
-| token      | string | The Discord voice token to authenticate with                                                |
-| endpoint   | string | The Discord voice endpoint to connect to                                                    |
-| sessionId  | string | The Discord voice session id to authenticate with                                           |
+| Field     | Type   | Description                                       |
+|-----------|--------|---------------------------------------------------|
+| token     | string | The Discord voice token to authenticate with      |
+| endpoint  | string | The Discord voice endpoint to connect to          |
+| sessionId | string | The Discord voice session id to authenticate with |
 
 `token`, `endpoint`, and `sessionId` are the 3 required values for connecting to one of Discord's voice servers.
 `sessionId` is provided by the Voice State Update event sent by Discord, whereas the `endpoint` and `token` are provided
@@ -621,11 +621,11 @@ Response:
 
 ###### Load Result Data - Playlist
 
-| Field      | Type                                  | Description                                 |
-|------------|---------------------------------------|---------------------------------------------|
-| info       | [PlaylistInfo](#playlist-info) object | The info of the playlist                    |
-| pluginInfo | Object                                | Addition playlist info provided by plugins  |
-| tracks     | array of [Track](#track) objects      | The tracks of the playlist                  |
+| Field      | Type                                  | Description                                |
+|------------|---------------------------------------|--------------------------------------------|
+| info       | [PlaylistInfo](#playlist-info) object | The info of the playlist                   |
+| pluginInfo | Object                                | Addition playlist info provided by plugins |
+| tracks     | array of [Track](#track) objects      | The tracks of the playlist                 |
 
 ###### Playlist Info
 

diff --git a/docs/api/websocket.md b/docs/api/websocket.md
@@ -337,10 +337,10 @@ Dispatched when a track throws an exception.
 
 ##### Severity
 
-| Severity     | Description                                                                                                                                                                                                                            |
-|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `common`     | The cause is known and expected, indicates that there is nothing wrong with the library itself                                                                                                                                         |
-| `suspicious` | The cause might not be exactly known, but is possibly caused by outside factors. For example when an outside service responds in a format that we do not expect                                                                        |
+| Severity     | Description                                                                                                                                                                                                                    |
+|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `common`     | The cause is known and expected, indicates that there is nothing wrong with the library itself                                                                                                                                 |
+| `suspicious` | The cause might not be exactly known, but is possibly caused by outside factors. For example when an outside service responds in a format that we do not expect                                                                |
 | `fault`      | The probable cause is an issue with the library or there is no way to tell what the cause might be. This is the default level and other levels are used in cases where the thrower has more in-depth knowledge about the error |
 
 <details>

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -10,6 +10,7 @@ The most noteworthy of these, as well as any features and breaking changes, are
 ## v4
 
 ### v4.0.0-beta.3
+
 * Update lavaplayer to [`2.0.0`](https://github.com/lavalink-devs/lavaplayer/releases/tag/2.0.0) - Fixed YouTube 403 errors & YouTube access token errors
 
 ### v4.0.0-beta.2

diff --git a/docs/configuration/index.md b/docs/configuration/index.md
@@ -7,18 +7,21 @@ description: How to configure Lavalink
 The server configuration is done in `application.yml`. You can find an example below.
 
 ## Example application.yml
+
 <details>
 <summary>application.yml</summary>
 
 ```yaml title="application.yml"
 --8<-- "LavalinkServer/application.yml.example"
 ```
+
 </details>
 
 Alternatively, you can also use environment variables to configure the server. The environment variables are named the same as the keys in the `application.yml` file, but in uppercase and with `.` replaced with `_`. For example, `server.port` becomes `SERVER_PORT`.
 For arrays, the index is appended to the key, starting at 0. For example, `LAVALINK_PLUGINS_0_DEPENDENCY` refers to the `dependency` key of the first plugin.
 
 ## Example environment variables
+
 <details>
 <summary>environment variables</summary>
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -27,4 +27,3 @@ If you want to run the Lavalink server without it closing when you close the ter
 ## Need Help?
 
 Join the [Lavalink support Discord](https://discord.gg/ZW4s47Ppw4) for help or questions.
-
diff --git a/docs/overrides/home.html b/docs/overrides/home.html
@@ -10,13 +10,13 @@
 <section class="container">
     <div class="md-grid md-typeset">
         <div class="logo">
-            <img id="home__logo" src="assets/images/lavalink.svg" alt="Lavalink Logo" draggable="false">
+            <img alt="Lavalink Logo" draggable="false" id="home__logo" src="assets/images/lavalink.svg">
             <h1 id="home__title">Lavalink</h1>
             <p class="description">
                 Standalone audio sending node based on Lavaplayer.
             </p>
-            <a href="getting-started.html" title="Using Lavalink" class="md-button md-button--primary">Get Started</a>
-            <a href="configuration/index.html" title="Configure Lavalink" class="md-button md-button--primary">Configuration</a>
+            <a class="md-button md-button--primary" href="getting-started.html" title="Using Lavalink">Get Started</a>
+            <a class="md-button md-button--primary" href="configuration/index.html" title="Configure Lavalink">Configuration</a>
             <p>
         </div>
         <div>

diff --git a/docs/stylesheets/style.css b/docs/stylesheets/style.css
@@ -9,6 +9,7 @@
 .container {
     margin-top: 1rem;
 }
+
 .container .logo {
     text-align: center;
 }