Add Troubleshooting Android section

src/SUMMARY.md

@@ -4,6 +4,7 @@
 
 - [Getting Started](guide/getting_started.md)
   - [Installing the Breez SDK](guide/install.md)
+    - [Troubleshooting Android](guide/android_troubleshooting.md)
   - [Connecting to a node](guide/connecting.md)
   - [Getting the node state](guide/node_state.md)
   - [Adding logging](guide/logging.md)

src/guide/android_troubleshooting.md

@@ -0,0 +1,76 @@
+# Troubleshooting Android
+
+When including the Breez SDK and/or Notification Plugin into your application you might come across issues compiling because: 
+- it uses `kotlinx-serialization`
+- it relies on JNA library
+
+If you do, there are several steps you can take to compile and build properly, even if they do not using the Notification Plugin feature.
+
+## kotlinx-serialization
+
+Starting with this 1.8.20 release, the Kotlin K2 compiler has a preview version of the serialization plugin. It's recommended for users to upgrade their Kotlin version to at least 1.8.20 or [set up the serialization plugin](https://github.com/Kotlin/kotlinx.serialization?tab=readme-ov-file#setup) on their projects explicitly with older versions.
+
+## JNA library
+
+JNA relies on specific class and method names to load native libraries and access native code. If these names are obfuscated or removed, it can cause runtime errors and failures in native library loading.
+
+To ensure proper functionality, a Proguard rules needs to be added to explicitly tell R8 compiler to keep certain parts of the JNA library. Here is an example of Proguard rules:
+```pro
+-dontwarn dalvik.system.VMStack
+-dontwarn java.lang.**
+-dontwarn javax.naming.**
+-dontwarn sun.reflect.Reflection
+
+# JNA
+-keep class com.sun.jna.** { *; }
+-keep class * implements com.sun.jna.** { *; }
+
+# Other
+-dontoptimize
+```
+
+These rules ensure that the JNA library's core components are not obfuscated, allowing the library to function correctly. See [Shrink, obfuscate, and optimize your app](https://developer.android.com/build/shrink-code) for more information on how and where to add Proguard rules on your app.
+
+## Inconsistent JVM-target compatibility
+
+It could be that compilation tasks for Java and Kotlin are using different JVM targets, in which case you need to set the [JVM toolchain](https://kotl.in/gradle/jvm/toolchain). In your application's `build.gradle` file in the `app` directory set the Java and Kotlin JVM targets consistently. 
+```
+kotlin {
+    jvmToolchain(17)
+}
+
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(17))
+    }
+}
+
+android {
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+
+    kotlinOptions {
+        jvmTarget = '17'
+    }
+}
+```
+
+## Java heap space
+
+```
+> Could not resolve all files for configuration
+    > Failed to transform react-android-0.72.10-debug.aar (com.facebook.react:react-android:0.72.10) 
+    to match attributes {artifactType=android-symbol-with-package-name, 
+    com.android.build.api.attributes.BuildTypeAttr=debug, org.gradle.category=library, 
+    org.gradle.dependency.bundling=external, or g.gradle.libraryelements=aar, org.gradle.status=release, 
+    org.gradle.usage=java-api}. 
+        > Java heap error
+```
+
+If you get a `Java heap space` error, try to increase the maximum memory allocation pool for the JVM in `gradle.properties`.
+
+```
+org.gradle.jvmargs=-Xmx3072m -XX:MaxMetaspaceSize=512m
+```

src/guide/install.md

@@ -56,7 +56,7 @@ dependencies {
 }
 ```
 
-See [the example](https://github.com/breez/breez-sdk-examples/tree/main/Android) for more details
+Please check the [troubleshooting guide](/guide/android_troubleshooting.md) if you are having problems compiling your Android application.
 
 ## React Native