Skip to content

Commit 2b40a68

Browse files
committed
docs: update outdated information
1 parent e147a56 commit 2b40a68

File tree

4 files changed

+14
-29
lines changed

4 files changed

+14
-29
lines changed

docs/content/architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ reverse proxy and are managed by `concurrently`.
88
Each version of Ryot is released as a docker image. Then it is associated with the latest
99
Github release of the major version. For example, if the latest tag is `v5.2.1`, then
1010
the Github release will be called `Version 5` and the docker image will be tagged as
11-
`:v5.2.1` and `:latest`.
11+
`:v5.2.1`, `v5.2`, `v5` and `:latest`.
1212

1313
## Development
1414

docs/content/guides/video-games.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A guide about video games integration for Ryot.
66

77
Ryot supports tracking video games via [IGDB](https://www.igdb.com/). However, the API is
88
heavily rate limited, so it is not possible to hardcode the API keys in the application
9-
(unlike the other keys).
9+
(unlike the others).
1010

1111
You can follow the below steps to obtain your own API keys and enable video game tracking.
1212

docs/content/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Installation
22

3-
If you would like to run the pro version, please check [below](#upgrading-to-pro). To see
4-
the features of the pro version, check the [features page]({{extra.main_website_url
5-
}}).
6-
73
```yaml
84
services:
95
ryot-db:
@@ -32,6 +28,10 @@ volumes:
3228
postgres_storage:
3329
```
3430
31+
If you would like to run the pro version, please check [below](#upgrading-to-pro). To see
32+
the features of the pro version, check the [features page]({{extra.main_website_url
33+
}}).
34+
3535
## Upgrading to Pro
3636
3737
!!! info
@@ -40,7 +40,7 @@ volumes:
4040
[backup](./guides/exporting.md#exporting-the-entire-database) your data before upgrading.
4141
4242
To upgrade to the pro version, you need to provide a `SERVER_PRO_KEY` environment variable.
43-
You can get a key by contacting us via the [website]({{ extra.main_website_url }}).
43+
You can get a key by purchasing it from the [website]({{ extra.main_website_url }}).
4444

4545
Once you have the key, you can set it in the `docker-compose.yml` file:
4646

docs/content/integrations.md

+7-22
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Integrations
22

3-
Integrations can be used to continuously update your media progress. They can be of two
4-
types:
3+
Integrations can be used to continuously update your media progress or inform external
4+
services about changes. They can be of following types:
55

66
- _Yank_: Progress data is downloaded from an externally running server at a periodic
77
interval.
8-
- _Push_: Ryot sends data to an external service.
8+
- _Push_: Ryot sends data to an external service at a periodic interval.
99
- _Sink_: An external client publishes progress updates to the Ryot server.
1010

1111
## Yank integrations
@@ -25,7 +25,7 @@ You can configure the interval at which the data is fetched from the external us
2525
[import](./importing.md#audiobookshelf) if you want to import media that are finished.
2626

2727
The [Audiobookshelf](https://www.audiobookshelf.org) integration can sync all media if they
28-
have an Audible ID or ITunes ID or ISBN.
28+
have a valid provider ID (Audible, ITunes or ISBN).
2929

3030
1. Obtain an API token as described in the Audiobookshelf
3131
[authentication](https://api.audiobookshelf.org/#authentication) docs.
@@ -34,7 +34,7 @@ have an Audible ID or ITunes ID or ISBN.
3434

3535
## Push integrations
3636

37-
Follow the same instructions as the [yank](#yank-integrations) integrations to add.
37+
Follow the same instructions as the [yank](#yank-integrations) integrations to add one.
3838

3939
### Radarr
4040

@@ -52,7 +52,8 @@ Automatically add shows in the selected collections to Sonarr.
5252

5353
## Sink integrations
5454

55-
All webhook URLs follow this format:
55+
These work via webhooks wherein an external service can inform Ryot about a change. All
56+
webhook URLs follow this format:
5657

5758
```txt
5859
https://<instance_url>/backend/_i/<slug>
@@ -136,19 +137,3 @@ TMDb ID attached to their metadata.
136137
the zipped addon to your Kodi instance. Once installed, it will be visible under
137138
the "Services" sub category named "Ryot".
138139
4. Click on "Configure" to fill in the correct details.
139-
140-
### Flow Launcher
141-
142-
!!! warning
143-
144-
This is a community maintained integration.
145-
146-
The plugin for [Flow Launcher](https://www.flowlauncher.com/) allows you to quickly
147-
search your Ryot tracker by media category:
148-
149-
![image](https://imgur.com/gVt9VBd.gif)
150-
151-
To install, search for "Ryot" in the Flow Launcher plugin store. Or use `pm install ryot`.
152-
153-
Refer to the [documentation](https://github.com/bretthysuik/Flow.Launcher.Plugin.Ryot#configuration)
154-
for post-install configuration.

0 commit comments

Comments
 (0)