add: mdbook for documentation

Author: Roardom

.github/workflows/mdbook.yml

@@ -0,0 +1,42 @@
+# Source: https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions
+name: Deploy Book
+on: [ push, pull_request ]
+# on:
+#   push:
+#     branches:
+#       - master
+
+jobs:
+    deploy-book:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write  # To push a branch
+            pull-requests: write  # To create a PR from that branch
+        steps:
+        -   uses: actions/checkout@v4
+            with:
+                fetch-depth: 0
+        -   name: Install latest mdbook
+            run: |
+                tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+                url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+                mkdir mdbook
+                curl -sSL $url | tar -xz --directory=./mdbook
+                echo `pwd`/mdbook >> $GITHUB_PATH
+        -   name: Deploy GitHub Pages
+            run: |
+                # This assumes your book is in the root of your repository.
+                # Just add a `cd` here if you need to change to another directory.
+                cd book
+                mdbook build
+                git worktree add gh-pages
+                git config user.name "Deploy from CI"
+                git config user.email ""
+                cd gh-pages
+                # Delete the ref to avoid keeping history.
+                git update-ref -d refs/heads/gh-pages
+                rm -rf *
+                mv ../book/* .
+                git add .
+                git commit -m "Deploy $GITHUB_SHA to gh-pages"
+                git push --force --set-upstream origin gh-pages

book/.gitignore

@@ -0,0 +1 @@
+book

book/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["EkoNesLeg", "HDVinnie", "Roardom"]
+language = "en"
+multilingual = false
+src = "src"
+title = "UNIT3D Documentation"

docs/README.md book/src/README.mddocs/README.md renamed to book/src/README.md

@@ -0,0 +1,11 @@
+# Summary
+
+- [Introduction](README.md)
+- [Basic Tuning](basic_tuning.md)
+- [Local Development Arch Linux](local_development_arch_linux.md)
+- [Local Development MacOS](local_development_macos.md)
+- [Meilisearch Setup](meilisearch_setup.md)
+- [Server Management](server_management.md)
+- [Sharing Source Code](sharing_source_code.md)
+- [Torrent API](torrent_api.md)
+- [Upgrading PHP Version](upgrading_php_version.md)