tubearchivist/tubearchivist-frontend
1
0
Fork 0
mirror of https://github.com/tubearchivist/tubearchivist-frontend.git synced 2024-12-22 18:00:17 +00:00
Code Issues Projects Releases Wiki Activity

fix links

Browse Source
This commit is contained in:
simon 2021-09-28 22:09:58 +07:00
parent 12ad8fcead
commit 108b1bac1f
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Downloads.md
View File

@ -3,12 +3,12 @@ Accessible at `/downloads/` of your Tube Archivist, this page handles all the do
## Rescan Subscriptions
The **Rescan subscriptions** icon <img src="../tubearchivist/static/img/icon-rescan.svg?raw=true" alt="rescan icon" width="20px" style="filter:invert(50%) sepia(9%) saturate(2940%) hue-rotate(122deg) brightness(94%) contrast(90%);margin:0 5px;"> will start a background task to look for new videos from the channels you are subscribed to. You can define the channel page size on the [settings page](Settings). With the default channel page size, expect this process to take around 2-3 seconds for each channel you are subscribed to. A status message will show the progress.
The **Rescan subscriptions** icon <img src="../tubearchivist/static/img/icon-rescan.svg?raw=true" alt="rescan icon" width="20px" style="filter:invert(50%) sepia(9%) saturate(2940%) hue-rotate(122deg) brightness(94%) contrast(90%);margin:0 5px;"> will start a background task to look for new videos from the channels you are subscribed to. You can define the channel page size on the [settings page](Settings.md#subscriptions). With the default channel page size, expect this process to take around 2-3 seconds for each channel you are subscribed to. A status message will show the progress.
Then for every video found, **Tube Archivist** will skip the video if it has already been downloaded or if you added it to the *ignored* list before. All the other videos will get added to the download queue. Expect this to take around 1 second for each video as **Tube Archivist** needs to grab some additional metadata. New videos will get added at the bottom of the download queue.
## Download Queue
The **Download Queue** icon <img src="../tubearchivist/static/img/icon-download.svg?raw=true" alt="download icon" width="20px" style="filter:invert(50%) sepia(9%) saturate(2940%) hue-rotate(122deg) brightness(94%) contrast(90%);margin:0 5px;"> will start the download process starting from the top of the queue. Take a look at the relevant settings on the [Settings Page](Settings). Once the process started, a progress message will show with additional details and controls:
The **Download Queue** icon <img src="../tubearchivist/static/img/icon-download.svg?raw=true" alt="download icon" width="20px" style="filter:invert(50%) sepia(9%) saturate(2940%) hue-rotate(122deg) brightness(94%) contrast(90%);margin:0 5px;"> will start the download process starting from the top of the queue. Take a look at the relevant settings on the [Settings Page](Settings.md#downloads). Once the process started, a progress message will show with additional details and controls:
- The stop icon <img src="../tubearchivist/static/img/icon-stop.svg?raw=true" alt="stop icon" width="20px" style="filter:invert(50%) sepia(9%) saturate(2940%) hue-rotate(122deg) brightness(94%) contrast(90%);margin:0 5px;"> will gracefully stop the download process, once the current video has been finished successfully.
- The cancel icon <img src="../tubearchivist/static/img/icon-close.svg?raw=true" alt="close icon" width="20px" style="filter:invert(16%) sepia(60%) saturate(3717%) hue-rotate(349deg) brightness(86%) contrast(120%);margin:0 5px;"> is equivalent to killing the process and will stop the download immediately. Any leftover files will get deleted, the canceled video will still be available in the download queue.

16
docs/Home.md
View File

@ -5,16 +5,16 @@
Welcome to the official Tube Archivist Wiki. This is an up-to-date documentation of user functionality.
Table of contents:
* [Main](Main): Tube Archivist landing page
* [Channels](Channels): Browse your channels, handle subscriptions
* [Downloads](Downloads): Scanning subscriptions, handle download queue
* [Settings](Settings): All the configuration options
* [Main](Main.md): Tube Archivist landing page
* [Channels](Channels.md): Browse your channels, handle subscriptions
* [Downloads](Downloads.md): Scanning subscriptions, handle download queue
* [Settings](Settings.md): All the configuration options
## Getting Started
1. [Subscribe](Channels#channels-overview) to some of your favourite YouTube channels.
2. [Scan](Downloads#rescan-subscriptions) subscriptions to add the latest videos to the download queue.
3. [Add](Downloads#add-to-download-queue) additional videos, channels or playlist - ignore the ones you don't want to download.
4. [Download](Downloads#download-queue) and let **Tube Archivist** do it's thing.
1. [Subscribe](Channels.md#channels-overview) to some of your favourite YouTube channels.
2. [Scan](Downloads.md#rescan-subscriptions) subscriptions to add the latest videos to the download queue.
3. [Add](Downloads.md#add-to-download-queue) additional videos, channels or playlist - ignore the ones you don't want to download.
4. [Download](Downloads.md#download-queue) and let **Tube Archivist** do it's thing.
5. Sit back and enjoy your archived and indexed collection!
## General Navigation

2
docs/Settings.md
View File

@ -8,7 +8,7 @@ Switch between the easy on the eyes dark theme and the burning bright theme.
## Archive View
These default values will get applied on container restart.
- **Default Sort**: This defines the default sort order as described on the [Main](Main) page.
- **Default Sort**: This defines the default sort order as described on the [Main](Main.md) page.
- **Default Hide Watched**: Hide watched videos by default.
- **Show Subscribed Channels Only**: This controls the filter on the *Channel Overview Page*.
- **Page Size**: Defines how many results get displayed on a given page. Same value goes for all archive views.