ci: doc format check (#2325)

* ci: doc format check

* chore: linting

docs/docs/FAQ.md

@@ -22,11 +22,11 @@ The initial approach of Immich is to become a backup tool, primarily for mobile
 
 ### Why does my uploaded photo show up with the wrong date or time in Immich?
 
-When a photo is initially uploaded Immich uses the create date of the file to determine where it belongs in the timeline. After that, background jobs will run that extract [exif metadata](https://en.wikipedia.org/wiki/Exif), including the CreateDate, to provide a more accurate date for the photo. If that is not available it will fallback to the modified date. If you want to ensure your photo has the right date, check the exif metadata before uploading. 
+When a photo is initially uploaded Immich uses the create date of the file to determine where it belongs in the timeline. After that, background jobs will run that extract [exif metadata](https://en.wikipedia.org/wiki/Exif), including the CreateDate, to provide a more accurate date for the photo. If that is not available it will fallback to the modified date. If you want to ensure your photo has the right date, check the exif metadata before uploading.
 
-If the timezone is incorrect in an uploaded photo, check the ``DateTimeOriginal`` exif field of the uploaded file. Immich uses the very competent library [exiftool-vendored.js](https://github.com/photostructure/exiftool-vendored.js#dates) to handle timezone parsing, but in some cases (like photos taken with DSLR cameras) it has to fallback on the local timezone. If you are using docker, this fallback will be UTC. (Note that even the photo backup app that can't be named [has the same bug!](https://photo.stackexchange.com/a/126978)) In Immich, it is possible to change this assumed fallback timezone system-wide by setting the timezone in the microservices docker container. You might need to run the "Extract Metadata" job after to effect the change. 
+If the timezone is incorrect in an uploaded photo, check the `DateTimeOriginal` exif field of the uploaded file. Immich uses the very competent library [exiftool-vendored.js](https://github.com/photostructure/exiftool-vendored.js#dates) to handle timezone parsing, but in some cases (like photos taken with DSLR cameras) it has to fallback on the local timezone. If you are using docker, this fallback will be UTC. (Note that even the photo backup app that can't be named [has the same bug!](https://photo.stackexchange.com/a/126978)) In Immich, it is possible to change this assumed fallback timezone system-wide by setting the timezone in the microservices docker container. You might need to run the "Extract Metadata" job after to effect the change.
 
-As an example, the following modification of ```docker-compose.yml``` will set the timezone of the microservices container to be ``Europe/Stockholm``
+As an example, the following modification of `docker-compose.yml` will set the timezone of the microservices container to be `Europe/Stockholm`
 
 ```
     environment:
@@ -34,9 +34,11 @@ As an example, the following modification of ```docker-compose.yml``` will set t
 ```
 
 ### Why are only photos and not videos being uploaded to Immich?
+
 This often happens when using a reverse proxy or cloudflare tunnel in front of Immich. Make sure to set your reverse proxy to allow large POST requests. In `nginx`, set `client_max_body_size 50000M;` or similar. Cloudflare tunnels are limited to 100 mb file sizes.
 
 ### Why is Immich slow on low-memory systems like the Raspberry Pi?
+
 Immich uses optional machine-learning features to enhance search results. This feature, however, can be too heavy to run on a Raspberry Pi. To disable machine learning, comment out the `immich-machine-learning` section of your docker-compose.yml and set `IMMICH_MACHINE_LEARNING_URL=false` in your .env file.
 
 ### What happens to existing files after I choose a new [Storage Template](/docs/administration/storage-template.mdx)?
@@ -44,6 +46,7 @@ Immich uses optional machine-learning features to enhance search results. This f
 Template changes will only apply to new assets. To retroactively apply the template to previously uploaded assets, run the Storage Migration Job, available on the [Jobs](/docs/administration/jobs.md) page.
 
 ### In the uploads folder, why are photos stored in the wrong date?
+
 This is fixed by running the storage migration job.
 
 ### Why is object detection not very good?
@@ -83,4 +86,4 @@ After removing the the containers and volumes, the **Files** can be cleaned up (
 
 ### Why iOS app shows duplicate photos on the timeline while the web doesn't?
 
-If you are using `My Photo Stream`, the Photos app temporarily creates duplicates of photos taken in the last 30 days. These photos are included in the `Recents` album and thus shown up twice. To fix this, you can disable `My Photo Stream` in the native Photos app or choose a different album in the backup screen in Immich.
+If you are using `My Photo Stream`, the Photos app temporarily creates duplicates of photos taken in the last 30 days. These photos are included in the `Recents` album and thus shown up twice. To fix this, you can disable `My Photo Stream` in the native Photos app or choose a different album in the backup screen in Immich.

docs/docs/administration/_category_.json

@@ -1,5 +1,4 @@
 {
-    "label": "Administration",
-    "position": 4
-  }
-  
+  "label": "Administration",
+  "position": 4
+}

docs/docs/developer/architecture.md

@@ -36,7 +36,6 @@ Immich is a full-stack [TypeScript](https://www.typescriptlang.org/) application
 - [Redis](https://redis.io/) for job queuing.
 - [Typesense](https://typesense.org/) for search.
 
-
 ### Web Server
 
 - [NGINX](https://www.nginx.com/) for internal communication between containers and load balancing when scaling.

docs/docs/features/automatic-backup.md

@@ -14,17 +14,19 @@ Background backup is available thanks to the contribution effort of [@zoodyy](ht
 
 If background backup is enabled. The app will periodically check if there are any new photos or videos in the selected album(s) to be uploaded to the cloud. If there are, it will upload them to the cloud in the background.
 
-
 :::info Note
 
 #### General
+
 - The app must be in the background for the backup worker to start running.
 - If you reopen the app and the first page you see is the backup page, the counts will not reflect the background uploaded result. You have to navigate out of the page and come back to see the updated counts.
 
 #### Android
+
 - It is a well-known problem that some Android models are very strict with battery optimization settings, which can cause a problem with the background worker. Please visit [Don't kill my app](https://dontkillmyapp.com/) for a guide on disabling this setting on your phone.
 
 #### iOS
+
 - You must enable **Background App Refresh** for the app to work in the background. You can enable it in the Settings app under General > Background App Refresh.
 
 <div style={{textAlign: 'center'}}>

docs/docs/features/bulk-upload.md

@@ -49,7 +49,6 @@ The API key can be obtained in the user setting panel on the web interface.
 
 ![Obtain Api Key](./img/obtain-api-key.png)
 
-
 ### Run via Docker
 
 You can run the CLI inside of a docker container to avoid needing to install anything.
@@ -74,6 +73,7 @@ immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api
 
 :::tip Internal networking
 If you are running the CLI container on the same machine as your Immich server, you may not be able to reach the external address. In that case, try the following steps:
+
 1. Find the internal Docker network used by Immich via `docker network ls`.
 2. Adapt the above command to pass the `--network <immich_network>` argument to `docker run`, substituting `<immich_network>` with the result from step 1.
 3. Use `--server http://immich-server:3001/` for the upload command instead of the external address.
@@ -81,6 +81,7 @@ If you are running the CLI container on the same machine as your Immich server,
 ```bash title="Upload to internal address"
 docker run --network immich_default -it --rm -v "$(pwd):/import" ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://immich-server:3001/
 ```
+
 :::
 
 ### Run from source

docs/docs/features/reverse-geocoding.md

@@ -4,7 +4,7 @@ Immich supports [Reverse Geocoding](https://en.wikipedia.org/wiki/Reverse_geocod
 
 ## Extraction
 
-During Exif Extraction, assets with latitudes and longitudes are reverse geocoded to determine their City, State, and Country. 
+During Exif Extraction, assets with latitudes and longitudes are reverse geocoded to determine their City, State, and Country.
 
 ## Usage
 

docs/docs/features/search.md

@@ -1,6 +1,6 @@
 # Search
 
-Immich uses Typesense as the primary search database to enable high performance search mechanism. 
+Immich uses Typesense as the primary search database to enable high performance search mechanism.
 
 Typesense is a powerful search engine that can be integrated with popular natural language processing (NLP) models like CLIP and SBERT to provide highly accurate and relevant search results. Here are some benefits of using Typesense integrated search for CLIP and SBERT:
 
@@ -10,11 +10,11 @@ Faster Search Response Times: Typesense is optimized for lightning-fast search r
 
 Enhanced Semantic Search Capabilities: CLIP and SBERT are powerful NLP models that can extract the semantic meaning from text, enabling more nuanced search queries. By integrating with Typesense, these models can help to improve the accuracy of semantic search, enabling users to find the most relevant results based on the true meaning of their query.
 
-Greater Search Flexibility: Typesense provides flexible search capabilities, including fuzzy search, partial search, enabling users to find the information they need quickly and easily. When integrated with CLIP and SBERT, Typesense can offer even greater flexibility, allowing users to refine their search queries using natural language and providing more accurate and relevant results. 
+Greater Search Flexibility: Typesense provides flexible search capabilities, including fuzzy search, partial search, enabling users to find the information they need quickly and easily. When integrated with CLIP and SBERT, Typesense can offer even greater flexibility, allowing users to refine their search queries using natural language and providing more accurate and relevant results.
 
 (Generated by Chat-GPT4)
 
-Some search examples: 
-<img src={require('./img/search-ex-2.webp').default}  title='Search Example 1' />
+Some search examples:
+<img src={require('./img/search-ex-2.webp').default} title='Search Example 1' />
 
 <img src={require('./img/search-ex-3.webp').default} title='Search Example 2' />

docs/docs/features/user-settings.md

@@ -10,7 +10,7 @@ View your User ID and email, and update your first and last name.
 
 ## Change Password
 
-Users can change their own passwords. 
+Users can change their own passwords.
 
 ![Change Password](./img/user-change-password.png)
 

docs/docs/install/portainer.md

@@ -13,37 +13,36 @@ Install Immich using Portainer's Stack feature.
 5. Replace `.env` with `stack.env` for all containers that need to use environment variables in the web editor.
 
 <img
-  src={require('./img/dot-env.png').default}
-  width="50%"
-  style={{border: '1px solid #ddd'}}
-  alt="Dot Env Example"
+src={require('./img/dot-env.png').default}
+width="50%"
+style={{border: '1px solid #ddd'}}
+alt="Dot Env Example"
 />
 
 8. Click on "**Advanced Mode**" in the **Environment Variables** section.
 
 <img
-  src={require('./img/env-1.png').default}
-  width="50%"
-  style={{border: '1px solid #ddd'}}
-  alt="Dot Env Example"
+src={require('./img/env-1.png').default}
+width="50%"
+style={{border: '1px solid #ddd'}}
+alt="Dot Env Example"
 />
 
 9. Copy the content of the `example.env` file from the [GitHub repository](https://github.com/immich-app/immich/releases/latest/download/example.env) and paste into the editor.
 10. Switch back to "**Simple Mode**".
 
 <img
-  src={require('./img/env-2.png').default}
-  width="50%"
-  style={{border: '1px solid #ddd'}}
-  alt="Dot Env Example"
+src={require('./img/env-2.png').default}
+width="50%"
+style={{border: '1px solid #ddd'}}
+alt="Dot Env Example"
 />
 
-* Populate custom database information if necessary.
-* Populate `UPLOAD_LOCATION` with your preferred location for storing backup assets.
+- Populate custom database information if necessary.
+- Populate `UPLOAD_LOCATION` with your preferred location for storing backup assets.
 
 11. Click on "**Deploy the stack**".
 
-
 :::tip
 For more information on how to use the application, please refer to the [Post Installation](/docs/install/post-install.mdx) guide.
 :::

docs/docs/install/requirements.md

@@ -2,8 +2,8 @@
 sidebar_position: 10
 ---
 
-
 # Requirements
+
 Hardware and software requirements for Immich
 
 ## Software

docs/docs/install/unraid.md

@@ -5,6 +5,7 @@ sidebar_position: 60
 # Unraid
 
 Immich can easily be installed and updated on Unraid via:
+
 1. [Docker Compose Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) plugin from the Unraid Community Apps
 2. Community made template on the Unraid Community Apps
 
@@ -20,7 +21,7 @@ In order to install Immich from the Unraid CA, you will need an existing Redis a
 
 Once you have Redis and PostgreSQL running, search for Immich on the Unraid CA, choose either of the templates listed and fill out the example variables.
 
-For more information about setting up the community image see [here](https://github.com/imagegenius/docker-immich#application-setup) 
+For more information about setting up the community image see [here](https://github.com/imagegenius/docker-immich#application-setup)
 
 ## Docker-Compose Method (Official)
 

docs/docs/overview/introduction.mdx

@@ -4,7 +4,7 @@ sidebar_position: 1
 
 # Introduction
 
-<img src={require('./img/feature-panel.png').default} alt='Immich' />
+<img src={require('./img/feature-panel.png').default} alt="Immich" />
 
 ## Welcome!
 

docs/docs/overview/support-the-project.md

@@ -18,7 +18,6 @@ If you feel like this is the right cause and the app is something you see yourse
 - [buymeacoffee](https://www.buymeacoffee.com/altran1502)
 - Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
 
-
 ## Contributing
 
 There are lots of non-monetary ways to contribute to Immich as well.