Merge branch 'documentation'

.github/workflows/documentation.yaml

@@ -0,0 +1,29 @@
+name: documentation
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

docs/index.md

@@ -0,0 +1,2 @@
+# Welcome to Transmission 
+

mkdocs.yml

@@ -0,0 +1,18 @@
+site_name: Transmission
+repo_url: https://github.com/trendyol/transmission
+theme:
+  name: material
+  features:
+  - content.code.annotate
+  - content.tabs.link
+  - content.tooltips
+  - header.autohide
+  - navigation.top
+  - navigation.tracking
+  - navigation.sections
+  - navigation.indexes
+  - navigation.footer
+  - search.highlight
+  - search.share
+  - search.suggest
+  - toc.integrate