Remove unnecessary headers

leancodepl · Dec 3, 2024 · fb95cde · fb95cde
1 parent e62a07e
commit fb95cde
Show file tree

Hide file tree

Showing 30 changed files with 157 additions and 57 deletions.
diff --git a/docs.json b/docs.json
@@ -40,6 +40,11 @@
       "title": "Documentation",
       "href": "/documentation"
     },
+    {
+      "id": "cli",
+      "title": "CLI commands",
+      "href": "/cli-commands/develop"
+    },
     {
       "id": "patrol api ref",
       "title": "Patrol API reference",
@@ -53,6 +58,14 @@
         {
           "title": "Getting started",
           "href": "/overview/getting-started"
+        },
+        {
+          "title": "Improved logging and reporting is here!",
+          "href": "logs-announcement"
+        },
+        {
+          "title": "LeanCode",
+          "href": "https://leancode.co"
         }
       ]
     },
@@ -66,7 +79,7 @@
         },
         {
           "title": "Write your first test",
-          "href": "google.com"
+          "href": "/documentation/write-your-first-test"
         },
         {
           "title": "Logs and test results",
@@ -81,6 +94,145 @@
           "href": "/documentation/compatibility-table"
         }
       ]
+    },
+    {
+      "group": "Advanced",
+      "tab": "documentation",
+      "pages": [
+        {
+          "group": "Finders",
+          "pages": [
+            {
+              "title": "Overview",
+              "href": "/finders/overview"
+            },
+            {
+              "title": "Usage",
+              "href": "/finders/usage"
+            },
+            {
+              "title": "Advanced",
+              "href": "/finders/advanced"
+            },
+            {
+              "title": "Using Patrol finders in widget tests",
+              "href": "/finders/finders-setup"
+            }
+          ]
+        },
+        {
+          "group": "Native automation",
+          "pages": [
+            {
+              "title": "Overview",
+              "href": "/native/overview"
+            },
+            {
+              "title": "Usage",
+              "href": "/native/usage"
+            },
+            {
+              "title": "Advanced",
+              "href": "/native/advanced"
+            },
+            {
+              "title": "Feature parity",
+              "href": "/native/feature-parity"
+            }
+          ]
+        },
+        {
+          "group": "Patrol and CI",
+          "pages": [
+            {
+              "title": "Overview",
+              "href": "/ci/overview"
+            },
+            {
+              "title": "Platforms",
+              "href": "/ci/platforms"
+            },
+            {
+              "title": "Firebase Test Lab",
+              "href": "/ci/firebase-test-lab"
+            }
+          ]
+        },
+        {
+          "group": "Integrations",
+          "pages": [
+            {
+              "title": "Allure",
+              "href": "/integrations/allure"
+            },
+            {
+              "title": "Browserstack",
+              "href": "/integrations/browserstack"
+            }
+          ]
+        },
+        {
+          "group": "Other",
+          "pages": [
+            {
+              "title": "Effective Patrol",
+              "href": "/effective-patrol"
+            },
+            {
+              "title": "Tips and tricks",
+              "href": "/tips-and-tricks"
+            },
+            {
+              "title": "Debugging Patrol tests",
+              "href": "/debugging-patrol-tests"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "group": "CLI commands",
+      "tab": "cli",
+      "pages": [
+        {
+          "title": "develop",
+          "href": "/cli-commands/develop"
+        },
+        {
+          "title": "test",
+          "href": "/cli-commands/test"
+        },
+        {
+          "title": "build",
+          "href": "/cli-commands/build"
+        },
+        {
+          "title": "doctor",
+          "href": "/cli-commands/doctor"
+        },
+        {
+          "title": "update",
+          "href": "/cli-commands/update"
+        },
+        {
+          "title": "devices",
+          "href": "/cli-commands/devices"
+        }
+      ]
+    },
+    {
+      "group": "Announcements",
+      "tab": "root",
+      "pages": [
+        {
+          "title": "Patrol 3.0 is here!",
+          "href": "/v3"
+        },
+        {
+          "title": "New package - patrol_finders",
+          "href": "/patrol-finders-release"
+        }
+      ]
     }
   ]
 }
diff --git a/docs/ci/firebase-test-lab.mdx b/docs/ci/firebase-test-lab.mdx
@@ -2,8 +2,6 @@
 title: CI - Firebase Test Lab
 ---
 
-# Firebase Test Lab
-
 There are many device lab providers. Below we're showing how to run Patrol tests
 on [Firebase Test Lab], because it's popular in the Flutter community, but the
 instructions should be similar for other device farms, such as [AWS Device

diff --git a/docs/ci/overview.mdx b/docs/ci/overview.mdx
@@ -2,8 +2,6 @@
 title: CI - Overview
 ---
 
-# Continuous Integration
-
 This section of the documentation is focused on running Patrol tests as part of
 your Continuous Integration workflows.
 

diff --git a/docs/cli-commands/build.mdx b/docs/cli-commands/build.mdx
@@ -2,8 +2,6 @@
 title: Commands - build
 ---
 
-# build
-
 ### Synopsis
 
 Build app binaries for integration testing.

diff --git a/docs/cli-commands/develop.mdx b/docs/cli-commands/develop.mdx
@@ -2,8 +2,6 @@
 title: Commands - develop
 ---
 
-# develop
-
 ### Synopsis
 
 Develop integration tests with Hot Restart.

diff --git a/docs/cli-commands/devices.mdx b/docs/cli-commands/devices.mdx
@@ -2,8 +2,6 @@
 title: Commands - devices
 ---
 
-# devices
-
 ### Synopsis
 
 List attached devices, simulators and emulators

diff --git a/docs/cli-commands/doctor.mdx b/docs/cli-commands/doctor.mdx
@@ -2,8 +2,6 @@
 title: Commands - doctor
 ---
 
-# doctor
-
 ### Synopsis
 
 Show information about installed tooling.

diff --git a/docs/cli-commands/test.mdx b/docs/cli-commands/test.mdx
@@ -2,8 +2,6 @@
 title: Commands - test
 ---
 
-# test
-
 ### Synopsis
 
 Run integration tests.

diff --git a/docs/cli-commands/update.mdx b/docs/cli-commands/update.mdx
@@ -2,8 +2,6 @@
 title: Commands - update
 ---
 
-# update
-
 ### Synopsis
 
 Update Patrol CLI to the latest version.

diff --git a/docs/documentation/compatibility-table.mdx b/docs/documentation/compatibility-table.mdx
@@ -2,8 +2,6 @@
 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

diff --git a/docs/documentation/index.mdx b/docs/documentation/index.mdx
@@ -2,8 +2,6 @@
 title: Getting started
 ---
 
-# Getting started
-
 Check out our video version of this tutorial on YouTube!
 
 <YouTube id="zwQB8LfnTN8" />
@@ -68,7 +66,7 @@ Patrol UI tests. It is necessary to run UI tests (`flutter test` won't work! [He
 1. Install `patrol_cli` executable:
 
    ```
-   dart pub global activate patrol_cli
+   flutter pub global activate patrol_cli
    ```
 
   <Info>

diff --git a/docs/documentation/logs.mdx b/docs/documentation/logs.mdx
@@ -2,8 +2,6 @@
 title: Logs and test results
 ---
 
-# Logs and test results
-
 Once you've written and executed your tests, it's essential to monitor their results. Patrol provides two main methods for reporting test outcomes: **console logs** and **native test reports**.
 
 ## Logging test steps

diff --git a/docs/documentation/supported-platforms.mdx b/docs/documentation/supported-platforms.mdx
@@ -2,8 +2,6 @@
 title: Supported platforms
 ---
 
-# Supported platforms
-
 Patrol works on:
 
 - Android 5.0 (API 21) and newer,

diff --git a/docs/write-your-first-test.mdx → docs/documentation/write-your-first-test.mdx b/docs/write-your-first-test.mdx → docs/documentation/write-your-first-test.mdx
@@ -2,8 +2,6 @@
 title: Write your first test
 ---
 
-# Write your first test
-
 Patrol is a powerful, open-source testing framework created by LeanCode that enhances Flutter's testing capabilities by enabling interaction with native platform features directly in Dart. It allows to handle permission dialogs, notifications, WebViews, and device settings—features previously unavailable in standard Flutter tests, making it truly possible to test the whole app.
 
 This tutorial will take you through writing your first substantial Patrol test, interacting both with the Flutter app itself and also with native permission dialogs and notifications.

diff --git a/docs/effective-patrol.mdx b/docs/effective-patrol.mdx
@@ -2,8 +2,6 @@
 title: Effective Patrol
 ---
 
-# Effective Patrol
-
 Over the past months, we've written many Patrol tests and often learned the hard
 way what works well and what doesn't. We're sharing our findings hoping that
 they'll help you write robust tests.

diff --git a/docs/finders/advanced.mdx b/docs/finders/advanced.mdx
@@ -2,8 +2,6 @@
 title: Patrol finders - advanced
 ---
 
-# Advanced
-
 We aim to make Patrol as simple as possible, but there are still a few matters
 that we feel require some more attention. We'll explain them in this section.
 

diff --git a/docs/finders/finders-setup.mdx b/docs/finders/finders-setup.mdx
@@ -2,8 +2,6 @@
 title: Using Patrol finders in widget tests
 ---
 
-# Using Patrol finders in widget tests
-
 Since `patrol_finders` is a separate package, referenced in `patrol` package,
 you can use it in your widget or golden tests, without depending on `patrol`.
 Below you can find a short tutorial on how to use `$` in already existing widget tests.

diff --git a/docs/finders/overview.mdx b/docs/finders/overview.mdx
@@ -2,8 +2,6 @@
 title: Patrol finders - overview
 ---
 
-# Custom finders overview
-
 Flutter's finders are powerful, but not very intuitive to use.
 
 We took them and made something awesome.

diff --git a/docs/finders/usage.mdx b/docs/finders/usage.mdx
@@ -2,8 +2,6 @@
 title: Patrol finders - usage
 ---
 
-# Usage
-
 This page introduces Patrol finder system. Let's get our hands dirty
 and find some widgets!
 

diff --git a/docs/integrations/allure.mdx b/docs/integrations/allure.mdx
@@ -2,7 +2,7 @@
 title: Integrations - allure
 ---
 
-# Allure overview
+## Overview
 
 If you're using [Allure] to report your test results, you can use the
 alternative test runner to get more detailed test report.

diff --git a/docs/integrations/browserstack.mdx b/docs/integrations/browserstack.mdx
@@ -2,7 +2,7 @@
 title: Integrations - Browserstack
 ---
 
-# Browserstack overview
+## Overview
 
 [Browserstack App Automate] is a popular cloud device farm.
 

diff --git a/docs/logs-announcement.mdx b/docs/logs-announcement.mdx
@@ -2,8 +2,6 @@
 title: Improved logging and reporting is here!
 ---
 
-# Big Update: Enhanced Logging and Test Reporting!
-
 We’ve made some major improvements to how you can monitor and analyze your tests! With Patrol 3.13.0 and later, you’ll get:
 
  - Verbose logging: Test names are now displayed in real time as they’re executed!

diff --git a/docs/native/advanced.mdx b/docs/native/advanced.mdx
@@ -2,8 +2,6 @@
 title: Native automation - advanced
 ---
 
-# Advanced
-
 ### Patrol section in `pubspec.yaml`
 
 If your app has different name on iOS and Android, you can specify `app_name`

diff --git a/docs/native/feature-parity.mdx b/docs/native/feature-parity.mdx
@@ -2,8 +2,6 @@
 title: Native feature's parity
 ---
 
-# Feature parity
-
 Here you can see what you can already do with Patrol, and what is yet to be
 implemented. We hope that it will help you evaluate Patrol.
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,8 +2,6 @@ @@
     title: Commands - build
     ---
-    # build
     ### Synopsis
     Build app binaries for integration testing.
@@ Expand Down @@