docs: document known issue with JsonConverter under Scala 2 and update site navigation

- Added documentation for the `JsonConverter` issue with `Any` on Scala 2.
- Introduced a "Known Issues" section in the site navigation.

Author: QuadStingray

docs/.vitepress/config.ts

@@ -141,9 +141,17 @@ function sidebarDocumentation() {
             collapsible: true,
             collapsed: true,
         },
+        {
+            text: 'Known Issues',
+            link: '/documentation/known-issues', items: [
+                {text: 'Json Converter', link: '/documentation/known-issues/json-converter'},
+            ],
+            collapsible: true,
+            collapsed: true,
+        },
         {
             text: 'LocalServer',
             link: '/documentation/local-server'
-        }
+        },
     ]
 }

docs/documentation/known-issues/index.md

@@ -0,0 +1,3 @@
+# Known Issues
+
+* [Json Converter](json-converter.md)

docs/documentation/known-issues/json-converter.md

@@ -0,0 +1,8 @@
+# Known Issues - Json Converter
+
+## Scala 2
+Under scala 2 the json converter have some issues with the json parser and the Any Class in `toJson` Method and needs an explicit cast to `Any`. Circe does not support this format by default.
+
+For scala 3 you can ignore this issue.
+
+<<< @/../src/test/scala/dev/mongocamp/driver/mongodb/json/JsonConversionSuite.scala#known-issue-any-format{scala}

src/test/scala/dev/mongocamp/driver/mongodb/json/JsonConversionSuite.scala

@@ -20,6 +20,7 @@ class JsonConversionSuite extends munit.FunSuite {
   }
 
   test("Convert Case Class with Any to Json") {
+    // #region known-issue-any-format
     val isScala3 = scala.util.Properties.versionNumberString.startsWith("3.")
     val jString3: String = if (isScala3) {
       jsonConverter.toJson(HelloWorld3("servus", "welt"))
@@ -28,6 +29,7 @@ class JsonConversionSuite extends munit.FunSuite {
       jsonConverter.toJson(HelloWorld3("servus", "welt").asInstanceOf[Any])
     }
     assertEquals(jString3, "{\"greetings\":\"servus\",\"name\":\"welt\"}")
+    // #endregion known-issue-any-format
   }
 
   test("Convert Json to Case Class with Option using anyFormat") {