docs: fix comments in mdx files (#3141)

MDX uses `{/* ... */}` for comments

.github/vale/styles/.gitignore

@@ -1,4 +1,7 @@
 *
 !Makefile
 !LibreTime
-!Vocab
+!config/
+!config/*
+!config/vocabularies/*
+!config/vocabularies/Docs/*

.github/workflows/docs.yml

@@ -43,7 +43,7 @@ jobs:
             errata-ai/vale \
             vale_{version}_Linux_64-bit.tar.gz --extract vale \
             /usr/local/bin/vale \
-            --version v2.21.3 \
+            --version v3.9.6 \
             --version-file '{destination}.version'
 
       - name: Add annotations matchers

.vale.ini

@@ -6,12 +6,26 @@ Packages = \
 
 Vocab = Docs
 
-[*.md]
+# Ignore MDX components
+IgnoredScopes = code, tt, img, url, a
+SkippedScopes = script, style, pre, figure, code
+
+[formats]
+# This is a workaround until https://github.com/errata-ai/vale/issues/841 is fixed
+mdx = md
+
+[*.{md,mdx}]
 BasedOnStyles = Vale, Microsoft, LibreTime
 
 # Exclude emoji shortcodes `:tada:`
 BlockIgnores = (:[a-z-_]+:)
 
+# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs, and angle brackets
+TokenIgnores = (<\/?[A-Z].+>), (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
+
 Microsoft.GeneralURL = False
 Microsoft.RangeFormat = False
 Vale.Spelling = False
+
+[*.mdx]
+CommentDelimiters = {/*, */}

docs/contributor-manual/development-workflows.md

@@ -13,7 +13,7 @@ LibreTime uses [Github pull requests to manage changes](https://docs.github.com/
 - Lint and test the codebase, for example using the `make lint` or `make test` commands inside the app folder you want to check.
 - Push your branch.
 - Create a pull request in Github.
-- We'll review your request and provide feed back.
+- Your request will be reviewed and feedback provided.
 
 ## Project layout
 

docs/contributor-manual/releases.md

@@ -48,7 +48,7 @@ git commit -m "docs: add release note"
 
 ### 4. Merge the release pull request
 
-Push any changes that we previously made to the release branch:
+Push any changes that were previously made to the release branch:
 
 ```bash
 git push

docs/releases/3.0.0-alpha.11.mdx

@@ -13,7 +13,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - @jooola
 - @paddatrapper
 
-<!-- vale off -->
+{/* vale off */}
 
 ## :rocket: Features
 
@@ -118,7 +118,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - **installer:** remove /var/tmp/airtime reference
 - **worker:** drop logfile reference until environment variable expansion works correctly
 
-<!-- vale on -->
+{/* vale on */}
 
 ## :arrow_up: Upgrading
 

docs/releases/3.0.0-alpha.13.mdx

@@ -16,7 +16,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - Maxime Leroy
 - Mykola
 
-<!-- vale off -->
+{/* vale off */}
 
 ## :rocket: Features
 
@@ -102,7 +102,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - use track_type_id in smartblock criteria
 - **legacy:** no invalid track type in smartblock criteria
 
-<!-- vale on -->
+{/* vale on */}
 
 ## :fire: Deprecation and removal
 

docs/releases/3.0.0-beta.0.mdx

@@ -14,7 +14,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - @paddatrapper
 - Milo Ivir
 
-<!-- vale off -->
+{/* vale off */}
 
 ## :rocket: Features
 
@@ -103,7 +103,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
 - nginx depends on legacy in docker-compose ([#2147](https://github.com/libretime/libretime/issues/2147))
 - **playout:** remove shutdown_handler
 
-<!-- vale on -->
+{/* vale on */}
 
 ## :fire: Deprecation and removal
 

docs/releases/unreleased.mdx

@@ -4,7 +4,7 @@ title: Unreleased
 
 import ReleaseHead from "./_release-head.mdx";
 
-<!-- <ReleaseHead date='2022-01-01' version='3.0.0-alpha.11'/> -->
+{/* <ReleaseHead date='2022-01-01' version='3.0.0-alpha.11'/> */}
 
 ## :sparkling_heart: Contributors