Merge pull request #2040 from leancodepl/docs/compatibility-table

Add compatibility table to docs

docs.json

@@ -70,6 +70,7 @@
     ],
     ["Effective Patrol", "/effective-patrol"],
     ["Tips and tricks", "/tips-and-tricks"],
+    ["Compatibility table", "/compatibility-table"],
     ["LeanCode", "https://leancode.co"]
   ]
 }

docs/compatibility-table.mdx

@@ -0,0 +1,20 @@
+---
+title: Compatibility table
+---
+
+# Compatibility table
+
+The following table describes which versions of `patrol`
+and `patrol_cli` are compatible with each other.
+The simplest way to ensure that both packages are compatible
+is by always using the latest version. However,
+if for some reason that isn't possible, you can refer to 
+the table below to assess which version you should use.
+
+|     patrol     |   patrol_cli   |
+| -------------- | -------------- |
+| 3.0.0 -        | 2.3.0 -        |
+| 2.3.0 - 2.3.2  | 2.2.0 - 2.2.2  |
+| 2.0.1 - 2.2.5  | 2.0.1 - 2.1.5  |
+| 2.0.0          | 2.0.0          |
+| 1.0.9 - 1.1.11 | 1.1.4 - 1.1.11 |

docs/getting-started.mdx

@@ -263,7 +263,7 @@ Psst... Android is a bit easier to set up, so we recommend starting with it!
 
 </Accordion>
 
-<Accordion defaultOpen title="macOS setup">
+<Accordion title="macOS setup">
 
       1. Open `macos/Runner.xcworkspace` in Xcode. 
 
@@ -416,7 +416,7 @@ up. To run `integration_test/example_test.dart` on a connected Android, iOS or m
       ```
 
       If the setup is successful, you should see a **TEST PASSED** message. 
-      If something went wrong, please proceed to the [FAQ](/getting-started#faq) section which might
+      If something went wrong, please proceed to the [FAQ] section which might
       contain an answer to your issue.
 
       <Info>
@@ -462,8 +462,8 @@ up. To run `integration_test/example_test.dart` on a connected Android, iOS or m
 ### FAQ
 
 <Accordion title="Testing fails with error inside 'integration_test/test_bundle.dart'">
-  The reason is probably a mismatch of `patrol` and `patrol_cli` versions. Make sure that you 
-  use the latest versions of both packages.
+  The reason is probably a mismatch of `patrol` and `patrol_cli` versions. Go to [Compatibility table]
+  and make sure that the versions of `patrol` and `patrol_cli` you are using are compatible.
 </Accordion>
 
 <Accordion title="'example_test.dart' passed but I can't get my application to run 
@@ -538,3 +538,5 @@ To learn how to write Patrol tests, see [finders] and [native automation] sectio
 [Using Patrol finders in widget tests]: /patrol/finders/finders-setup
 [Here's why]: /native/advanced#embrace-the-native-tests
 [Patrol CLI]: https://pub.dev/packages/patrol_cli
+[FAQ]: /getting-started#faq
+[Compatibility table]: /compatibility-table

packages/patrol_cli/lib/src/base/constants.dart

@@ -1,2 +1,3 @@
 /// Version of Patrol CLI. Must be kept in sync with pubspec.yaml.
+/// If you update this, make sure that compatibility-table.mdx is updated (if needed)
 const version = '2.5.0';