Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs preview test #943

Merged
merged 2 commits into from
Aug 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
1 change: 0 additions & 1 deletion docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
20 changes: 10 additions & 10 deletions docs/api/rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions docs/api/websocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
1 change: 0 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

6 changes: 3 additions & 3 deletions docs/overrides/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions docs/stylesheets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
.container {
margin-top: 1rem;
}

.container .logo {
text-align: center;
}
Expand Down