Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs update #2440

Merged
merged 19 commits into from
Dec 5, 2024
328 changes: 244 additions & 84 deletions docs.json
Original file line number Diff line number Diff line change
@@ -1,106 +1,266 @@
{
"$schema": "https://docs.page/schema.json",
"name": "Patrol",
"twitter": "leancodepl",
"theme": "#FFA03F",
"description": "Flutter-first UI testing framework",
"theme": {
"primary": "#FFA03F"
},
"favicon": "/assets/favicon-dark.png",
"logo": "/assets/favicon-light.png",
"logoDark": "/assets/favicon-dark.png",
"logo": {
"light": "/assets/favicon-light.png",
"dark": "/assets/favicon-dark.png"
},
"socialPreview": "https://raw.githubusercontent.com/leancodepl/patrol/master/docs/assets/preview.jpg",
"googleAnalytics": "G-2REFSQEXJZ",
"docsearch": {
"appId": "HFSGK31MT8",
"apiKey": "4d41430f0f5928c58db0acfdace04a8b",
"indexName": "patrol-leancode"
"scripts": {
"googleAnalytics": "G-2REFSQEXJZ"
},
"social": {
"x": "leancodepl",
"github": "leancodepl/patrol",
"discord": "ukBK5t4EZg"
},
"search": {
"docsearch": {
"appId": "HFSGK31MT8",
"apiKey": "4d41430f0f5928c58db0acfdace04a8b",
"indexName": "patrol-leancode"
}
},
"content": {
"showPageTitle": false,
"zoomImages": true
},
"header": {
"showName": true,
"showGitHubCard": true,
"showThemeToggle": true,
"links": []
},
"anchors": [
{
"title": "Join our Discord",
"icon": "discord",
"link": "https://discord.gg/ukBK5t4EZg"
"title": "Discord",
"href": "https://discord.gg/ukBK5t4EZg",
"icon": "discord"
},
{
"title": "patrol API reference",
"icon": "code",
"link": "https://pub.dev/documentation/patrol/latest/index.html"
"href": "https://pub.dev/documentation/patrol/latest/index.html",
"icon": "code"
},
{
"title": "patrol_finders API reference",
"icon": "code",
"link": "https://pub.dev/documentation/patrol_finders/latest/index.html"
"href": "https://pub.dev/documentation/patrol_finders/latest/index.html",
"icon": "code"
}
],
"tabs": [
{
"id": "root",
"title": "Overview",
"href": "/"
},
{
"id": "documentation",
"title": "Documentation",
"href": "/documentation"
},
{
"id": "cli",
"title": "CLI commands",
"href": "/cli-commands"
}
],
"sidebar": [
["Patrol", "/"],
["Improved logging and reporting is here!", "logs-announcement"],
[
"Introduction",
[
["Getting started", "/getting-started"],
["Write your first test", "/write-your-first-test"],
["Logs and test results", "/logs"],
["Supported platforms", "/supported-platforms"],
["Compatibility table", "/compatibility-table"]
]
],
[
"Finders",
[
["Overview", "/finders/overview"],
["Usage", "/finders/usage"],
["Advanced", "/finders/advanced"],
["Using Patrol finders in widget tests", "/finders/finders-setup"]
]
],
[
"Native automation",
[
["Overview", "/native/overview"],
["Usage", "/native/usage"],
["Advanced", "/native/advanced"],
["Feature parity", "/native/feature-parity"]
]
],
[
"CLI commands",
[
["build", "/cli-commands/build"],
["develop", "/cli-commands/develop"],
["devices", "/cli-commands/devices"],
["doctor", "/cli-commands/doctor"],
["test", "/cli-commands/test"],
["update", "/cli-commands/update"]
{
"tab": "root",
"pages": [
{
"title": "Getting started",
"href": "/overview/getting-started"
},
{
"title": "Improved logging and reporting is here!",
"href": "logs-announcement"
},
{
"title": "LeanCode",
"href": "https://leancode.co"
}
]
],
[
"Patrol and CI",
[
["Overview", "/ci/overview"],
["Platforms", "/ci/platforms"],
["Firebase Test Lab", "/ci/firebase-test-lab"]
},
{
"group": "Introduction",
"tab": "documentation",
"pages": [
{
"title": "Install",
"href": "/documentation"
},
{
"title": "Write your first test",
"href": "/documentation/write-your-first-test"
},
{
"title": "Logs and test results",
"href": "/documentation/logs"
},
{
"title": "Cheat sheet",
"href": "/documentation/cheatsheet"
},
{
"title": "Supported platforms",
"href": "/documentation/supported-platforms"
},
{
"title": "Compatibility table",
"href": "/documentation/compatibility-table"
}
]
],
[
"Integrations",
[
["Allure", "/integrations/allure"],
["Browserstack", "/integrations/browserstack"]
},
{
"group": "Advanced",
"tab": "documentation",
"pages": [
{
"group": "Finders",
"tab": "documentation",
"pages": [
{
"title": "Overview",
"href": "/documentation/finders/overview"
},
{
"title": "Usage",
"href": "/documentation/finders/usage"
},
{
"title": "Advanced",
"href": "/documentation/finders/advanced"
},
{
"title": "Using Patrol finders in widget tests",
"href": "/documentation/finders/finders-setup"
}
]
},
{
"group": "Native automation",
"tab": "documentation",
"pages": [
{
"title": "Overview",
"href": "/documentation/native/overview"
},
{
"title": "Usage",
"href": "/documentation/native/usage"
},
{
"title": "Advanced",
"href": "/documentation/native/advanced"
},
{
"title": "Feature parity",
"href": "/documentation/native/feature-parity"
}
]
},
{
"group": "Patrol and CI",
"tab": "documentation",
"pages": [
{
"title": "Overview",
"href": "/documentation/ci/overview"
},
{
"title": "Platforms",
"href": "/documentation/ci/platforms"
},
{
"title": "Firebase Test Lab",
"href": "/documentation/ci/firebase-test-lab"
}
]
},
{
"group": "Integrations",
"tab": "documentation",
"pages": [
{
"title": "Allure",
"href": "/documentation/integrations/allure"
},
{
"title": "Browserstack",
"href": "/documentation/integrations/browserstack"
}
]
},
{
"group": "Other",
"tab": "documentation",
"pages": [
{
"title": "Effective Patrol",
"href": "/documentation/effective-patrol"
},
{
"title": "Tips and tricks",
"href": "/documentation/tips-and-tricks"
},
{
"title": "Debugging Patrol tests",
"href": "/documentation/debugging-patrol-tests"
}
]
}
]
],
[
"Announcements",
[
["Patrol 3.0 is here!", "/v3"],
["New package - patrol_finders", "/patrol-finders-release"]
},
{
"group": "CLI commands",
"tab": "cli",
"pages": [
{
"title": "develop",
"href": "/cli-commands"
},
{
"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"
}
]
],
[
"Other",
[
["Effective Patrol", "/effective-patrol"],
["Tips and tricks", "/tips-and-tricks"],
["Debugging Patrol tests", "/debugging-patrol-tests"],
["LeanCode", "https://leancode.co"]
},
{
"group": "Announcements",
"tab": "root",
"pages": [
{
"title": "Patrol 3.0 is here!",
"href": "/v3"
},
{
"title": "New package - patrol_finders",
"href": "/patrol-finders-release"
}
]
]
}
]
}
}
14 changes: 14 additions & 0 deletions docs/announcements/logs-announcement.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Improved logging and reporting is here!
---

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!
- Detailed step reporting: See every action Patrol takes during your test execution, giving you deeper insights into the process.
- Flutter logs in console: Now you can access Flutter logs directly within the patrol test output, streamlining debugging and analysis.
These enhancements will make it easier than ever to understand what's happening behind the code.

For a full breakdown of these updates, check out the [Logs and test results][logs] page!

[logs]: /documentation/logs
27 changes: 27 additions & 0 deletions docs/announcements/patrol-finders-release.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: New package - patrol_finders
---

We're introducing [`patrol_finders`] - a new package in Patrol framework! It was
created to make it easier to use Patrol finders in widget tests.

We decided to separate out our finders mechanism to another package, so
developers who would like to use Patrol's awesome finders in their widget tests
don't need to depend on whole Patrol package. This way you can conveniently use
Patrol finders in widget or golden tests, whichever platforms you need to
support in your project!

### How to use it?

We made a short tutorial on how to use `patrol_finders` package separately in
widget tests, you can find it in [Using Patrol finders in widget tests] section.

### Does this change affect my Patrol tests?

If you have already some Patrol tests in your project, there are no breaking
changes in this release - everything works the same as before. Though you may
see some deprecation warnings in your code - you can get your code aligned with
them to prepare for future changes.

[Using Patrol finders in widget tests]: /documentation/finders/finders-setup
[`patrol_finders`]: https://pub.dev/packages/patrol_finders
Loading
Loading