From fd2befd2a1f5e5f3cab20a9b7c2d3b39e4c92a3f Mon Sep 17 00:00:00 2001
From: Maximilian Dorninger <97409287+maxdorninger@users.noreply.github.com>
Date: Mon, 5 Jan 2026 21:39:18 +0100
Subject: [PATCH] Migrate to gitbook (#357)
This PR facilities the migration from the old Writerside documentation
platform to Gitbook.
## motivation
Gitbook supports serving multiple versions of the documentation, e.g.
v1.12.1, v1.13.0, and master.
---
.github/ISSUE_TEMPLATE/bug_report.md | 2 +-
.github/workflows/build-docs.yml | 139 -------
CONTRIBUTING.md | 2 +-
README.md | 8 +-
Writerside/Writerside_libraries.tree | 9 -
Writerside/c.list | 6 -
Writerside/cfg/buildprofiles.xml | 34 --
.../images/authentik-example-config.png | Bin 128351 -> 0 bytes
.../images/authentik-redirect-url-example.png | Bin 249719 -> 0 bytes
Writerside/images/favicon.ico | Bin 15406 -> 0 bytes
Writerside/images/logo.svg | 158 --------
Writerside/images/pocketid-example-config.png | Bin 56063 -> 0 bytes
Writerside/images/screenshot-dashboard.png | Bin 9299917 -> 0 bytes
.../images/screenshot-download-season.png | Bin 65745 -> 0 bytes
Writerside/images/screenshot-login.png | Bin 5818445 -> 0 bytes
.../images/screenshot-request-season.png | Bin 33443 -> 0 bytes
Writerside/images/screenshot-settings.png | Bin 38938 -> 0 bytes
Writerside/images/screenshot-tv-dashboard.png | Bin 7931499 -> 0 bytes
Writerside/images/screenshot-tv-torrents.png | Bin 126005 -> 0 bytes
Writerside/mm.tree | 35 --
Writerside/redirection-rules.xml | 45 ---
Writerside/topics/Advanced-Features.md | 4 -
Writerside/topics/Configuration.md | 75 ----
Writerside/topics/Custom-Libraries.md | 54 ---
Writerside/topics/Custom-port.md | 4 -
.../Follow-symlinks-in-frontend-files.md | 6 -
Writerside/topics/Importing-existing-media.md | 78 ----
Writerside/topics/Indexer-Settings.md | 74 ----
Writerside/topics/Introduction.topic | 74 ----
Writerside/topics/Logging.md | 17 -
Writerside/topics/Notifications.md | 121 ------
Writerside/topics/Scoring-Rulesets.md | 141 -------
Writerside/topics/Screenshots.md | 17 -
Writerside/topics/User-Guide.md | 51 ---
Writerside/topics/api-reference.md | 8 -
Writerside/topics/authentication-setup.md | 95 -----
Writerside/topics/configuration-backend.md | 48 ---
Writerside/topics/configuration-overview.md | 64 ----
Writerside/topics/contributing.md | 1 -
Writerside/topics/database-configuration.md | 42 ---
Writerside/topics/developer-guide.md | 349 ------------------
.../topics/download-client-configuration.md | 161 --------
.../topics/metadata-provider-configuration.md | 89 -----
Writerside/topics/notes.topic | 19 -
Writerside/topics/qBittorrent-Category.md | 12 -
Writerside/topics/troubleshooting.md | 57 ---
Writerside/topics/url-prefix.md | 34 --
Writerside/v.list | 5 -
Writerside/writerside.cfg | 9 -
config.dev.toml | 2 +-
config.example.toml | 2 +-
web/src/routes/dashboard/about/+page.svelte | 2 +-
web/src/routes/login/+layout.svelte | 2 +-
53 files changed, 10 insertions(+), 2145 deletions(-)
delete mode 100644 .github/workflows/build-docs.yml
delete mode 100644 Writerside/Writerside_libraries.tree
delete mode 100644 Writerside/c.list
delete mode 100644 Writerside/cfg/buildprofiles.xml
delete mode 100644 Writerside/images/authentik-example-config.png
delete mode 100644 Writerside/images/authentik-redirect-url-example.png
delete mode 100644 Writerside/images/favicon.ico
delete mode 100644 Writerside/images/logo.svg
delete mode 100644 Writerside/images/pocketid-example-config.png
delete mode 100644 Writerside/images/screenshot-dashboard.png
delete mode 100644 Writerside/images/screenshot-download-season.png
delete mode 100644 Writerside/images/screenshot-login.png
delete mode 100644 Writerside/images/screenshot-request-season.png
delete mode 100644 Writerside/images/screenshot-settings.png
delete mode 100644 Writerside/images/screenshot-tv-dashboard.png
delete mode 100644 Writerside/images/screenshot-tv-torrents.png
delete mode 100644 Writerside/mm.tree
delete mode 100644 Writerside/redirection-rules.xml
delete mode 100644 Writerside/topics/Advanced-Features.md
delete mode 100644 Writerside/topics/Configuration.md
delete mode 100644 Writerside/topics/Custom-Libraries.md
delete mode 100644 Writerside/topics/Custom-port.md
delete mode 100644 Writerside/topics/Follow-symlinks-in-frontend-files.md
delete mode 100644 Writerside/topics/Importing-existing-media.md
delete mode 100644 Writerside/topics/Indexer-Settings.md
delete mode 100644 Writerside/topics/Introduction.topic
delete mode 100644 Writerside/topics/Logging.md
delete mode 100644 Writerside/topics/Notifications.md
delete mode 100644 Writerside/topics/Scoring-Rulesets.md
delete mode 100644 Writerside/topics/Screenshots.md
delete mode 100644 Writerside/topics/User-Guide.md
delete mode 100644 Writerside/topics/api-reference.md
delete mode 100644 Writerside/topics/authentication-setup.md
delete mode 100644 Writerside/topics/configuration-backend.md
delete mode 100644 Writerside/topics/configuration-overview.md
delete mode 100644 Writerside/topics/contributing.md
delete mode 100644 Writerside/topics/database-configuration.md
delete mode 100644 Writerside/topics/developer-guide.md
delete mode 100644 Writerside/topics/download-client-configuration.md
delete mode 100644 Writerside/topics/metadata-provider-configuration.md
delete mode 100644 Writerside/topics/notes.topic
delete mode 100644 Writerside/topics/qBittorrent-Category.md
delete mode 100644 Writerside/topics/troubleshooting.md
delete mode 100644 Writerside/topics/url-prefix.md
delete mode 100644 Writerside/v.list
delete mode 100644 Writerside/writerside.cfg
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 4c0ff7f..05fb252 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -53,5 +53,5 @@ YOUR CONFIG HERE
```
- [ ] I understand, that without logs and/or screenshots and a detailed description of the problem, it is very hard to fix bugs.
- - [ ] I have checked the [documentation](https://maxdorninger.github.io/MediaManager/introduction.html) for help.
+ - [ ] I have checked the [documentation](https://maximilian-dorninger.gitbook.io/mediamanager) for help.
- [ ] I have searched the [issues](https://github.com/maxdorninger/MediaManager/issues) for similar issues and found none.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
deleted file mode 100644
index d158760..0000000
--- a/.github/workflows/build-docs.yml
+++ /dev/null
@@ -1,139 +0,0 @@
-name: Build documentation
-
-on:
- push:
- branches: [ "master" ]
- paths:
- - 'Writerside/**'
- - '.github/workflows/build-docs.yml'
- workflow_dispatch:
-
-permissions:
- contents: read
- id-token: write
- pages: write
-
-env:
- INSTANCE: 'Writerside/mm'
- DOCKER_VERSION: '2025.04.8412'
- ALGOLIA_APP_NAME: '5SXJTW5J6S'
- ALGOLIA_INDEX_NAME: 'MediaManagerDocs'
- CONFIG_JSON_PRODUCT: 'MM'
-
-jobs:
- build:
- runs-on: ubuntu-latest
- outputs:
- algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }}
- artifact: ${{ steps.define-ids.outputs.artifact }}
- steps:
- - name: Checkout repository
- uses: actions/checkout@v4
- with:
- fetch-depth: 0
-
- - name: Define instance id and artifacts
- id: define-ids
- run: |
- INSTANCE=${INSTANCE#*/}
- INSTANCE_ID_UPPER=$(echo "$INSTANCE" | tr '[:lower:]' '[:upper:]')
- ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip"
- ALGOLIA_ARTIFACT="algolia-indexes-${INSTANCE_ID_UPPER}.zip"
-
- # Print the values
- echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER"
- echo "ARTIFACT: $ARTIFACT"
- echo "ALGOLIA_ARTIFACT: $ALGOLIA_ARTIFACT"
-
- # Set the environment variables and outputs
- echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV
- echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV
- echo "ALGOLIA_ARTIFACT=$ALGOLIA_ARTIFACT" >> $GITHUB_ENV
- echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT
- echo "algolia_artifact=$ALGOLIA_ARTIFACT" >> $GITHUB_OUTPUT
-
- - name: Build docs using Writerside Docker builder
- uses: JetBrains/writerside-github-action@v4
- with:
- instance: ${{ env.INSTANCE }}
- docker-version: ${{ env.DOCKER_VERSION }}
-
- - name: Save artifact with build results
- uses: actions/upload-artifact@v4
- with:
- name: docs
- path: |
- artifacts/${{ steps.define-ids.outputs.artifact }}
- artifacts/report.json
- artifacts/${{ steps.define-ids.outputs.algolia_artifact }}
- retention-days: 7
- test:
- needs: build
- runs-on: ubuntu-latest
- steps:
- - name: Download artifacts
- uses: actions/download-artifact@v4
- with:
- name: docs
- path: artifacts
-
- - name: Test documentation
- uses: JetBrains/writerside-checker-action@v1
- with:
- instance: ${{ env.INSTANCE }}
- deploy:
- environment:
- name: github-pages
- url: ${{ steps.deployment.outputs.page_url }}
- needs: [ build, test ]
- if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
- runs-on: ubuntu-latest
- steps:
- - name: Download artifacts
- uses: actions/download-artifact@v4
- with:
- name: docs
- path: artifacts
-
- - name: Unzip artifact
- run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.artifact }}" -d dir
-
- - name: Setup Pages
- uses: actions/configure-pages@v4
-
- - name: Package and upload Pages artifact
- uses: actions/upload-pages-artifact@v3
- with:
- path: dir
-
- - name: Deploy to GitHub Pages
- id: deployment
- uses: actions/deploy-pages@v4
- publish-indexes:
- needs: [ build, test, deploy ]
- runs-on: ubuntu-latest
- if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
- container:
- image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
- steps:
- - name: Download artifact
- uses: actions/download-artifact@v4
- with:
- name: docs
- path: artifacts
- - name: Unzip Algolia artifact
- run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.algolia_artifact }}" -d algolia-indexes
- - name: Update Algolia Index
- run: |
- if [ -z "${{ secrets.ALGOLIA_KEY }}" ]; then
- echo "ALGOLIA_KEY secret is not set in GitHub Secrets"
- exit 1
- else
- env "algolia-key=${{ secrets.ALGOLIA_KEY }}" java -jar /opt/builder/help-publication-agent.jar \
- update-index \
- --application-name ${{ env.ALGOLIA_APP_NAME }} \
- --index-name ${{ env.ALGOLIA_INDEX_NAME }} \
- --product ${{ env.CONFIG_JSON_PRODUCT }} \
- --index-directory algolia-indexes/ \
- 2>&1 | tee algolia-update-index-log.txt
- fi
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 66ca907..8e0056c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -18,7 +18,7 @@ Generally, if you have any questions or need help on the implementation side of
just ask in the issue, or in a draft PR.
Also, see the contribution guide in the docs for information on how to setup the dev environment:
-https://maxdorninger.github.io/MediaManager/developer-guide.html
+https://maximilian-dorninger.gitbook.io/mediamanager
### For something that is a one or two line fix:
diff --git a/README.md b/README.md
index 8d05a92..1afae72 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
Modern management system for your media library
G*KO~BIF6T0HFJW$DN;Xm!!U`O>_*yzE%JKMEW6TPKNLyk#@&y@$*Q)Rn8r^>
zy|`cD$bPYYHrZ|OGS9&U! Yr0
z8tt3!4}m3qE~0i>9O g56oDW^u48dw|FD1Ox)wEL-l`@SI56(P8w
zTg6OW6BI_Lc&Pgh>P*L%Gt+&>io~}quYhP5A=6a*cr=D}|6u&JjoDC6K?Ff0UFNwL
zY~W+Iey^bos>hxZ%uhZD^Xbn&0L#@7L2@O=Z3(q&UDhrOehU*pd^tYGcdZ8v36
- Explore the docs »
+ Explore the docs »
Report Bug
·
@@ -37,7 +37,7 @@ wget -O ./config/config.toml https://raw.githubusercontent.com/maxdorninger/Medi
docker compose up -d
```
-### [View the docs for installation instructions and more](https://maxdorninger.github.io/MediaManager/configuration-overview.html#configuration-overview)
+### [View the docs for installation instructions and more](https://maximilian-dorninger.gitbook.io/mediamanager)
## Support MediaManager
@@ -82,7 +82,7 @@ docker compose up -d
## Developer Quick Start
-For the developer guide see the [Developer Guide](https://maxdorninger.github.io/MediaManager/developer-guide.html).
+For the developer guide see the [Developer Guide](https://maximilian-dorninger.gitbook.io/mediamanager).
diff --git a/Writerside/Writerside_libraries.tree b/Writerside/Writerside_libraries.tree
deleted file mode 100644
index c396ef3..0000000
--- a/Writerside/Writerside_libraries.tree
+++ /dev/null
@@ -1,9 +0,0 @@
-
-
-
-vTS^`*Q$&j(
z)SLH&0LATVBDRDM=XsT_{}IAhXM3e3EY)>m<&x>hhLjn`yB;Af*Tzkz?k=}2fA=Ai
zbVad(mQs^bBg}ZK66cTL6X)LMMct!=raL8fD4L=rapRtiEXd6}uNY{pcL6AtJn-B=
zCDY}8C3_L4NGnjF`hAO)%kGSklXueQqiwZTAeKM1N)BZr^Mv=f
z@j3NzWnnk{(ISYaDif#u$1Y!SK_r*Xp`V~f#jJ|}rV}#!9O1*`t=)LFB(BP-&}}@&
zL#Cwl(te5Y`1vSbT_82Rw~GDfZVdt?<#4Wm-pZqV7
khl#mk{4_{7
z;UbwL*78ECGClpe#gc2WPM96J=zDb;F1OH&HFuO
^?h#jbpuCI+7UiLom`-)tu=D>Z}ru@){FKcw#ZOj2_ORq!u)Nimgf)x
zG=^V*g2q;u%hTZ0$)VG?)A3CD4Z?^nRI-M5_^jq`t@j9XW=35ky2Xt(!fh8}P5h@@
zOWOoQBx2($D|^K0WEVMp_i`XuI+`Tuo=6aQ@v@k|T2B;d+60`VM~p2v_&H)1o-kG%
zS3Ri`%(^b4vPM=&Zk3YnUeUyhaQ<`UW%TIa=^|wfWXh}apdMmFk<&%dhRVK$Jaws@
zJVAo*A@G87mfk7pK>flgAtx(kQXv1#^{_=wJsp`Jr{fQJRxh1-3Lg&>I5HMrY>U_u
zCxh{N(*=nc0K*S<*c(#b1#kvWuZYA@;gp#%B}Ij2`1QbcKX-s+=rXgz-C=&^cMs~(
z_W^8xgGmwu17C1V80Z_IO+pXXGAeBL)>NPyL#Lkc1`WVQ#1IGElio;~z?Y|ZK&;SO
zNu`ubLVMN811-*5{N6-@-ttBo&(la+
q(oYm+QQnYH<)V)BxYu`sS=#
z5yEKp?M4dU{9rInjlHGVwyK5KuFB4lcsPjci6n0(AUML**nNx1#ax(L%hcaKsbluW
z&9B++^&a)%YGKV%F3vvEf7WahwjkHSD0Xe7yx>f{>&jP?qtp{reQL`f*(N%S3}5bV
zc&e{PRVDzBpp-<+T0(R2Dp*piD{b3lKhETP%Qpcw3w652#@DU3&-vWQYU#uvKN8Fw
zW1EBqT+3@W`d~m2;XQm