[PR #1] [MERGED] First iteration of the new docs site #20

New issue

Closed

opened 2026-03-23 20:37:46 +00:00 by mirror · 0 comments

mirror commented

2026-03-23 20:37:46 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/tubearchivist/docs/pull/1
Author: @jonasrosland
Created: 3/20/2023
Status: ✅ Merged
Merged: 3/20/2023
Merged by: @jonasrosland

Base: master ← Head: master

📝 Commits (2)

9114df6 Large rework of the existing documentation into MkDocs
965e85a Update README with extra packages needed

📊 Changes

37 files changed (+857 additions, -14 deletions)

View changed files

📝 README.md (+2 -2)
➕ mkdocs/docs/Channels.md (+54 -0)
➕ mkdocs/docs/Downloads.md (+62 -0)
➕ mkdocs/docs/FAQ.md (+36 -0)
➕ mkdocs/docs/Installation.md (+300 -0)
➕ mkdocs/docs/Playlists.md (+29 -0)
➕ mkdocs/docs/Search.md (+70 -0)
➕ mkdocs/docs/Settings.md (+195 -0)
➕ mkdocs/docs/Users.md (+20 -0)
➕ mkdocs/docs/Video.md (+25 -0)
➕ mkdocs/docs/assets/Synology_0.2.0_Docker-ES-Env-Conf.png (+0 -0)
➕ mkdocs/docs/assets/Synology_0.2.0_Docker-ES-Search.png (+0 -0)
➕ mkdocs/docs/assets/Synology_0.2.0_Docker-Folder-Create.png (+0 -0)
➕ mkdocs/docs/assets/Synology_0.2.0_Docker-Folder-Permissions-Commands.png (+0 -0)
➕ mkdocs/docs/assets/Synology_0.2.0_Docker-Folder-Structure.png (+0 -0)
➕ mkdocs/docs/assets/Synology_0.2.0_Docker-Install.png (+0 -0)
➕ mkdocs/docs/assets/Synology_0.2.0_Docker-Redis-Search.png (+0 -0)
➕ mkdocs/docs/assets/Synology_0.2.0_Docker-TA-Env-Conf.png (+0 -0)
➕ mkdocs/docs/assets/Synology_0.2.0_Docker-TA-Search.png (+0 -0)
➕ mkdocs/docs/assets/TubeArchivist-ES.png (+0 -0)

...and 17 more files

📄 Description

Changes:

Initial iteration of the new docs site
Corrected links between documents so they work properly
Added the Material theme for MkDocs
Added the markdown-callouts package for admonitions and collapsible blocks
Added navigation to both in-repo docs and other notable documents

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/tubearchivist/docs/pull/1 **Author:** [@jonasrosland](https://github.com/jonasrosland) **Created:** 3/20/2023 **Status:** ✅ Merged **Merged:** 3/20/2023 **Merged by:** [@jonasrosland](https://github.com/jonasrosland) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (2) - [`9114df6`](https://github.com/tubearchivist/docs/commit/9114df64de18c86869f0e04e967505dc7e7c06ad) Large rework of the existing documentation into MkDocs - [`965e85a`](https://github.com/tubearchivist/docs/commit/965e85a67f84ee5332970dad30f0a152f3b24852) Update README with extra packages needed ### 📊 Changes **37 files changed** (+857 additions, -14 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+2 -2) ➕ `mkdocs/docs/Channels.md` (+54 -0) ➕ `mkdocs/docs/Downloads.md` (+62 -0) ➕ `mkdocs/docs/FAQ.md` (+36 -0) ➕ `mkdocs/docs/Installation.md` (+300 -0) ➕ `mkdocs/docs/Playlists.md` (+29 -0) ➕ `mkdocs/docs/Search.md` (+70 -0) ➕ `mkdocs/docs/Settings.md` (+195 -0) ➕ `mkdocs/docs/Users.md` (+20 -0) ➕ `mkdocs/docs/Video.md` (+25 -0) ➕ `mkdocs/docs/assets/Synology_0.2.0_Docker-ES-Env-Conf.png` (+0 -0) ➕ `mkdocs/docs/assets/Synology_0.2.0_Docker-ES-Search.png` (+0 -0) ➕ `mkdocs/docs/assets/Synology_0.2.0_Docker-Folder-Create.png` (+0 -0) ➕ `mkdocs/docs/assets/Synology_0.2.0_Docker-Folder-Permissions-Commands.png` (+0 -0) ➕ `mkdocs/docs/assets/Synology_0.2.0_Docker-Folder-Structure.png` (+0 -0) ➕ `mkdocs/docs/assets/Synology_0.2.0_Docker-Install.png` (+0 -0) ➕ `mkdocs/docs/assets/Synology_0.2.0_Docker-Redis-Search.png` (+0 -0) ➕ `mkdocs/docs/assets/Synology_0.2.0_Docker-TA-Env-Conf.png` (+0 -0) ➕ `mkdocs/docs/assets/Synology_0.2.0_Docker-TA-Search.png` (+0 -0) ➕ `mkdocs/docs/assets/TubeArchivist-ES.png` (+0 -0) _...and 17 more files_ </details> ### 📄 Description Changes: * Initial iteration of the new docs site * Corrected links between documents so they work properly * Added the [Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/) * Added the [markdown-callouts](https://oprypin.github.io/markdown-callouts/index.html) package for admonitions and collapsible blocks * Added navigation to both in-repo docs and other notable documents --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>