diff --git a/mkdocs/docs/channels.md b/mkdocs/docs/channels.md index 919a679..1d1f705 100644 --- a/mkdocs/docs/channels.md +++ b/mkdocs/docs/channels.md @@ -1,3 +1,7 @@ +--- +description: Subscribe to channels, browse your channels and access additional metadata. +--- + # Channels Pages The channels are organized on two different levels, similar to the [playlists](playlists.md): diff --git a/mkdocs/docs/downloads.md b/mkdocs/docs/downloads.md index 26cc5a1..999a065 100644 --- a/mkdocs/docs/downloads.md +++ b/mkdocs/docs/downloads.md @@ -1,3 +1,7 @@ +--- +description: Populate your download queue by rescanning your Subscriptions or manually adding items to the download queue. +--- + # Downloads Page Accessible at `/downloads/` of your Tube Archivist, this page handles all the download functionality. diff --git a/mkdocs/docs/faq.md b/mkdocs/docs/faq.md index 6e2ff92..ceab0f2 100644 --- a/mkdocs/docs/faq.md +++ b/mkdocs/docs/faq.md @@ -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 ## What is the scope of this project? diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md index 42f8851..5655f9d 100644 --- a/mkdocs/docs/index.md +++ b/mkdocs/docs/index.md @@ -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 Welcome to the official Tube Archivist Docs. This is an up-to-date documentation of user functionality. diff --git a/mkdocs/docs/playlists.md b/mkdocs/docs/playlists.md index 328cadd..255ee28 100644 --- a/mkdocs/docs/playlists.md +++ b/mkdocs/docs/playlists.md @@ -1,3 +1,7 @@ +--- +description: Subscribe to playlists, browse your playlists and access additional metadata. +--- + # Playlist Pages The playlists are organized in two different levels, similar as the [channels](channels.md): diff --git a/mkdocs/docs/search.md b/mkdocs/docs/search.md index b29514b..91c3032 100644 --- a/mkdocs/docs/search.md +++ b/mkdocs/docs/search.md @@ -1,3 +1,7 @@ +--- +description: Unified search pagage to query your index. +--- + # 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. diff --git a/mkdocs/docs/settings.md b/mkdocs/docs/settings.md index 1a9f9c1..104bf50 100644 --- a/mkdocs/docs/settings.md +++ b/mkdocs/docs/settings.md @@ -1,3 +1,7 @@ +--- +description: Configure this project, yt-dlp behavior, the scheduler and more. +--- + # Settings Page Accessible at `/settings/` of your **Tube Archivist**, this page holds all the configurations and additional functionality related to the database. diff --git a/mkdocs/docs/users.md b/mkdocs/docs/users.md index 29c089b..06a65b7 100644 --- a/mkdocs/docs/users.md +++ b/mkdocs/docs/users.md @@ -1,3 +1,7 @@ +--- +description: Create users, reset passwords, acces the admin interface. +--- + # 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*. diff --git a/mkdocs/docs/video.md b/mkdocs/docs/video.md index 1483086..bd240ea 100644 --- a/mkdocs/docs/video.md +++ b/mkdocs/docs/video.md @@ -1,3 +1,7 @@ +--- +description: Complete Video metadata with playlist navigation and comments. +--- + # Video Page Every video downloaded gets a dedicated page accessible at `/video//` of your Tube Archivist. Throughout the interface, click on a video title to access the video page.