#298: Integrate MkDocs inside Astro lading page

.github/ISSUE_TEMPLATE/bug_report.md

@@ -28,9 +28,9 @@ Add any other context about the problem here.
 
 ---
 
-__🖐️ Learn [how to CONTRIBUTE](https://antoniomrtz.github.io/SpotifyElectron/CONTRIBUTING), all help is welcomed :)__
+__🖐️ Learn [how to CONTRIBUTE](https://antoniomrtz.github.io/SpotifyElectron_Web/docs/CONTRIBUTING/), all help is welcomed :)__
 
-__📚 Check out the [project documentation](https://antoniomrtz.github.io/SpotifyElectron/) for more info__
+__📚 Check out the [project documentation](https://antoniomrtz.github.io/SpotifyElectron_Web/docs/) for more info__
 
 __⭐ Help this project grow by giving it a star if you like it!__
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -24,9 +24,9 @@ How to test the feature
 
 ---
 
-__🖐️ Learn [how to CONTRIBUTE](https://antoniomrtz.github.io/SpotifyElectron/CONTRIBUTING), all help is welcomed :)__
+__🖐️ Learn [how to CONTRIBUTE](https://antoniomrtz.github.io/SpotifyElectron_Web/docs/CONTRIBUTING/), all help is welcomed :)__
 
-__📚 Check out the [project documentation](https://antoniomrtz.github.io/SpotifyElectron/) for more info__
+__📚 Check out the [project documentation](https://antoniomrtz.github.io/SpotifyElectron_Web/docs/) for more info__
 
 __⭐ Help this project grow by giving it a star if you like it!__
 

.github/ISSUE_TEMPLATE/issue_template.md

@@ -27,9 +27,9 @@
 
 ---
 
-__🖐️ Learn [how to CONTRIBUTE](https://antoniomrtz.github.io/SpotifyElectron/CONTRIBUTING), all help is welcomed :)__
+__🖐️ Learn [how to CONTRIBUTE](https://antoniomrtz.github.io/SpotifyElectron_Web/docs/CONTRIBUTING/), all help is welcomed :)__
 
-__📚 Check out the [project documentation](https://antoniomrtz.github.io/SpotifyElectron/) for more info__
+__📚 Check out the [project documentation](https://antoniomrtz.github.io/SpotifyElectron_Web/docs/) for more info__
 
 __⭐ Help this project grow by giving it a star if you like it!__
 

.github/workflows/deploy-gh-pages-website.yml

@@ -0,0 +1,21 @@
+name: Deploy Github pages with updated MkDocs on https://github.com/AntonioMrtz/SpotifyElectron_Web
+
+on:
+  pull_request:
+    types: [closed]
+  workflow_dispatch:
+
+jobs:
+  trigger-action:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true  # Check if PR was merged
+    steps:
+      - name: Trigger SpotifyElectron website Github pages deploy workflow
+        run: |
+          curl -L \
+            -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${{ secrets.Deploy_SpotifyElectron_Web_gh_pages }}" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            https://api.github.com/repos/AntonioMrtz/SpotifyElectron/dispatches \
+            -d '{"event_type":"deploy-with-mkdocs","client_payload":{"unit":false,"integration":true}}'

Backend/docker/env/dev.env

@@ -1,4 +1,4 @@
-#! Copy and rename this file to .env and move it to Backend/ root folder, more about environments on the official docs https://antoniomrtz.github.io/SpotifyElectron/backend/Environment/
+#! Copy and rename this file to .env and move it to Backend/ root folder, more about environments on the official docs https://antoniomrtz.github.io/SpotifyElectron_Web/docs/developer/backend/Environment/
 MONGO_URI=mongodb://root:root@127.0.0.1:27017/
 SECRET_KEY_SIGN=f24e2f3ac557d487b6d879fb2d86f2b2
 # PROD,DEV

README.md

@@ -27,7 +27,7 @@ Check out our [website](https://antoniomrtz.github.io/SpotifyElectron_Web/). Con
 
 ## 📚 Docs
 
-Check the [project documentation](https://antoniomrtz.github.io/SpotifyElectron/).
+Check the [project documentation](https://antoniomrtz.github.io/SpotifyElectron_Web/docs/).
 
 ## 🔽 Download Installer
 

docs/assets/drawio/song-architecture-file.drawio

@@ -64,7 +64,7 @@
         <mxCell id="1slNe64gq0bpDraKGNJo-20" value="(3) Convert encoded base64 byte song into an actual mp3 file. The file will be stored in the S3 Bucket" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
           <mxGeometry x="592.5" y="585" width="170" height="95" as="geometry" />
         </mxCell>
-        <mxCell id="1slNe64gq0bpDraKGNJo-21" value="(5) On incoming user HTTP requests for&lt;br&gt;playing a song backend will retrieve the url asociated to it. This url is embeded into the frontend music player" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
+        <mxCell id="1slNe64gq0bpDraKGNJo-21" value="(5) On incoming user HTTP requests for&lt;br&gt;playing a song backend will retrieve the url asociated to it. This url is embedded into the frontend music player" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
           <mxGeometry x="39.5" y="570" width="170" height="95" as="geometry" />
         </mxCell>
       </root>

docs/developer/utils/Mkdocs.md

@@ -1,6 +1,6 @@
 # 🗐 Mkdocs development & usage
 
-Project documentation will be deployed at `https://antoniomrtz.github.io/SpotifyElectron/`.
+Project documentation will be deployed at `https://antoniomrtz.github.io/SpotifyElectron_Web/docs/`.
 
 MkDocs is a static site generator specifically designed for creating project documentation. Written in Python, it allows developers to build and deploy documentation websites with ease. It uses Markdown for writing content, supports custom themes, and integrates well with version control systems like Git. With its simple configuration and built-in support for search, MkDocs is a popular choice for creating professional, easy-to-maintain documentation sites. More info [here](https://www.mkdocs.org/)
 
@@ -25,11 +25,7 @@ pip install -r requirements-docs.txt
 
 ## 🟩 Deployment
 
-There's a pipeline that pushes the latest documentation files into the prodution website. For manual deployment run:
-
-```console
-python -m mkdocs gh-deploy
-```
+Generated MkDocs static files are deployed inside https://antoniomrtz.github.io/SpotifyElectron_Web/docs/ when a PR is merged on main branch. This integration is done by one Github Action that triggers the deployment of the website on [website repository](https://github.com/AntonioMrtz/SpotifyElectron_Web).
 
 ## 🟧 Development
 

mkdocs.yml

@@ -1,5 +1,6 @@
 site_name: Spotify Electron
 site_author: Antonio Martinez Fernandez
+site_url: https://antoniomrtz.github.io/SpotifyElectron_Web/docs # Website deployment URL
 repo_url: https://github.com/AntonioMrtz/SpotifyElectron
 site_description: Documentation for Spotify Electron, an open-source cross-platform music streaming app
 remote_branch: gh-pages