Add "The images taken from Roborazzi seem broken" FAQ

takahirom · Mar 16, 2024 · f1aa6fd · f1aa6fd
1 parent 44498e3
commit f1aa6fd
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1192,6 +1192,14 @@ roborazzi {
     outputDir = "src/your/screenshot/folder"
 }
 ```
+
+### Q: The images taken from Roborazzi seem broken
+
+**A:** First, please check if you are using the correct version of the Android SDK. Consider using API level 28 or higher because it seems that Robolectric Native Graphics doesn't work property on older SDK versions.
+
+You can specify the SDK version like `@Config(sdk = [33])` or by using `robolectric.properties` with `sdk=33`.
+
+If your images are mostly fine but there are some drawing issues like shadows or shape graphics, you can try using Robolectric's Hardware Rendering mode. Please refer to [this issue](https://github.com/takahirom/roborazzi/issues/255#issuecomment-1914783987).
 </div>
 
 ### LICENSE

diff --git a/docs/topics/faq.md b/docs/topics/faq.md
@@ -93,4 +93,12 @@ out [the issue](https://github.com/takahirom/roborazzi/issues/193#issuecomment-1
 roborazzi {
     outputDir = "src/your/screenshot/folder"
 }
-```
+```
+
+### Q: The images taken from Roborazzi seem broken
+
+**A:** First, please check if you are using the correct version of the Android SDK. Consider using API level 28 or higher because it seems that Robolectric Native Graphics doesn't work property on older SDK versions.
+
+You can specify the SDK version like `@Config(sdk = [33])` or by using `robolectric.properties` with `sdk=33`.
+
+If your images are mostly fine but there are some drawing issues like shadows or shape graphics, you can try using Robolectric's Hardware Rendering mode. Please refer to [this issue](https://github.com/takahirom/roborazzi/issues/255#issuecomment-1914783987).