diff --git a/docs.json b/docs.json index 3d7440c7b..8b2c91911 100644 --- a/docs.json +++ b/docs.json @@ -70,6 +70,7 @@ ], ["Effective Patrol", "/effective-patrol"], ["Tips and tricks", "/tips-and-tricks"], + ["Compatibility table", "/compatibility-table"], ["LeanCode", "https://leancode.co"] ] } diff --git a/docs/compatibility-table.mdx b/docs/compatibility-table.mdx new file mode 100644 index 000000000..d4e2d98b8 --- /dev/null +++ b/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 | diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 77f8c8447..e90a89ac1 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -263,7 +263,7 @@ Psst... Android is a bit easier to set up, so we recommend starting with it! - + 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. @@ -462,8 +462,8 @@ up. To run `integration_test/example_test.dart` on a connected Android, iOS or m ### FAQ - 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.