add description metadata

This commit is contained in:
simon 2023-05-13 19:57:53 +07:00
parent 496b19a5d3
commit 0033522d1d
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
9 changed files with 36 additions and 0 deletions

View File

@ -1,3 +1,7 @@
---
description: Subscribe to channels, browse your channels and access additional metadata.
---
# Channels Pages # Channels Pages
The channels are organized on two different levels, similar to the [playlists](playlists.md): The channels are organized on two different levels, similar to the [playlists](playlists.md):

View File

@ -1,3 +1,7 @@
---
description: Populate your download queue by rescanning your Subscriptions or manually adding items to the download queue.
---
# Downloads Page # Downloads Page
Accessible at `/downloads/` of your Tube Archivist, this page handles all the download functionality. Accessible at `/downloads/` of your Tube Archivist, this page handles all the download functionality.

View File

@ -1,3 +1,7 @@
---
description: Frequently asked questions about what this project is, what it tries and what it doesn't try to do.
---
# Frequently Asked Questions # Frequently Asked Questions
## What is the scope of this project? ## What is the scope of this project?

View File

@ -1,3 +1,7 @@
---
description: Home of the documentation, additional installation instructions and user guide. Recommended reading for all interested in the project.
---
# Tube Archivist # Tube Archivist
Welcome to the official Tube Archivist Docs. This is an up-to-date documentation of user functionality. Welcome to the official Tube Archivist Docs. This is an up-to-date documentation of user functionality.

View File

@ -1,3 +1,7 @@
---
description: Subscribe to playlists, browse your playlists and access additional metadata.
---
# Playlist Pages # Playlist Pages
The playlists are organized in two different levels, similar as the [channels](channels.md): The playlists are organized in two different levels, similar as the [channels](channels.md):

View File

@ -1,3 +1,7 @@
---
description: Unified search pagage to query your index.
---
# Search Page # Search Page
Accessible at `/search/` of your **Tube Archivist**, search your archive for Videos, Channels and Playlists - or even full text search throughout your indexed subtitles. Accessible at `/search/` of your **Tube Archivist**, search your archive for Videos, Channels and Playlists - or even full text search throughout your indexed subtitles.

View File

@ -1,3 +1,7 @@
---
description: Configure this project, yt-dlp behavior, the scheduler and more.
---
# Settings Page # Settings Page
Accessible at `/settings/` of your **Tube Archivist**, this page holds all the configurations and additional functionality related to the database. Accessible at `/settings/` of your **Tube Archivist**, this page holds all the configurations and additional functionality related to the database.

View File

@ -1,3 +1,7 @@
---
description: Create users, reset passwords, acces the admin interface.
---
# User Management # User Management
For now, **Tube Archivist** is a single user application. You can create multiple users with different names and passwords, they will share the same videos and permissions but some interface configurations are on a per user basis. *More is on the roadmap*. For now, **Tube Archivist** is a single user application. You can create multiple users with different names and passwords, they will share the same videos and permissions but some interface configurations are on a per user basis. *More is on the roadmap*.

View File

@ -1,3 +1,7 @@
---
description: Complete Video metadata with playlist navigation and comments.
---
# Video Page # Video Page
Every video downloaded gets a dedicated page accessible at `/video/<video-id>/` of your Tube Archivist. Throughout the interface, click on a video title to access the video page. Every video downloaded gets a dedicated page accessible at `/video/<video-id>/` of your Tube Archivist. Throughout the interface, click on a video title to access the video page.