Improve Playwright Check Suites docs #48

stefanjudis · 2025-10-02T06:51:28Z

The main piece of the PR is a new document to highlight and explain test organization.

But I looked at the existing docs, too and cleaned up some additional things. :)

Copilot

Pull Request Overview

This PR improves Playwright Check Suites documentation by adding a comprehensive test organization guide and updating existing documentation for clarity and accuracy.

Adds a new "test-organization.mdx" document explaining how to structure and organize Playwright tests for synthetic monitoring
Updates existing documentation to improve clarity, fix typos, and update outdated references
Removes the quickstart.mdx file (likely moved elsewhere based on reference updates)

Reviewed Changes

Copilot reviewed 7 out of 12 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
docs.json	Adds the new test organization page to the documentation navigation
test-organization.mdx	New comprehensive guide covering test organization strategies and examples
quickstart.mdx	Removes the quickstart guide (moved to different location)
overview.mdx	Updates terminology, fixes references, and improves code examples
custom-dependencies.mdx	Improves formatting and clarity of dependency management instructions
configuration.mdx	Updates code examples and improves documentation structure
add-to-group.mdx	Cleans up code examples and updates reference links

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

detect/synthetic-monitoring/playwright-checks/test-organization.mdx

detect/synthetic-monitoring/playwright-checks/configuration.mdx

…n.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull Request Overview

Copilot reviewed 7 out of 12 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

detect/synthetic-monitoring/playwright-checks/test-organization.mdx

…n.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull Request Overview

Copilot reviewed 7 out of 12 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

detect/synthetic-monitoring/playwright-checks/test-organization.mdx

Copilot · 2025-10-02T06:59:23Z

detect/synthetic-monitoring/playwright-checks/test-organization.mdx

+        // Pick the Playwright project for the staging environment
+        pwProjects: ["user-sign-up"],


The comment mentions 'staging environment' but the code is configuring a 'user-sign-up' project. This comment appears to be copied from the environment grouping example above and should be updated to reflect the actual functionality.

detect/synthetic-monitoring/playwright-checks/test-organization.mdx

MariadeAnton

Wow, thanks for the thorough update and all the examples, these are all great @stefanjudis !

I've done a swipe for clarity and accuracy, please do accept/tweak as you see fit and let me know where I can help!

MariadeAnton · 2025-10-02T16:44:21Z

detect/synthetic-monitoring/playwright-checks/configuration.mdx

+Use the `checkly.config.ts/js` file to define your Playwright Check Suite. Each Playwright Check Suite can be connected to references in your `playwright.config.ts/js` file.

+<Info>
 During the Beta, **a Playwright Check Suite can run up to 20 minutes**. This limit can be adjusted based on feedback.


Suggested change

During the Beta, **a Playwright Check Suite can run up to 20 minutes**. This limit can be adjusted based on feedback.

**A Playwright Check Suite can run up to 15 minutes**. Please contact us if you're interested in longer runs.

MariadeAnton · 2025-10-02T16:45:02Z

detect/synthetic-monitoring/playwright-checks/configuration.mdx

 ## Playwright references

-The Checkly infrastructure will run and deploy all your existing Playwright tests (similar to what `npx playwright test` runs) as monitors if you don't reference Playwright projects or tags.
+Without limiting and selecting specific tests or Playwright projects, the Checkly infrastructure will run and deploy **all your existing Playwright tests** (similar to what `npx playwright test` runs) as monitors.


💯 for clarity

detect/synthetic-monitoring/playwright-checks/configuration.mdx

MariadeAnton · 2025-10-06T15:03:18Z

detect/synthetic-monitoring/playwright-checks/test-organization.mdx

+
+And configure different monitoring configuration for each Playwright project in your Playwright Check Suite.
+
+```typescript checkly.config.ts highlight={8-12, 17-21}


I love that we can now highlight lines in snippets!

Yep, I'm using the heck out of it. :D

detect/synthetic-monitoring/playwright-checks/test-organization.mdx

images/pwn-environment-grouping.png

Co-authored-by: María de Antón <maria@checklyhq.com>

… pwn-ga-launch-overhaul

…n.mdx Co-authored-by: María de Antón <maria@checklyhq.com>

… pwn-ga-launch-overhaul

MariadeAnton

🚀 ship it!

MariadeAnton · 2025-10-06T15:50:20Z

detect/synthetic-monitoring/playwright-checks/configuration.mdx

+        // Mute the check so that it doesn't send alerts
+        muted: false,
+        // Add a check to a group
+        groupName: 'production-group',


No docs PR in the making yet, just CLI WIP

Improve Playwright Check Suites docs

71222a9

stefanjudis requested review from MariadeAnton and Copilot October 2, 2025 06:51

Copilot AI reviewed Oct 2, 2025

View reviewed changes

mintlify bot deployed to staging October 2, 2025 06:52 View deployment

stefanjudis and others added 3 commits October 2, 2025 08:53

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

a0e0228

…n.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

8a0a9b5

…n.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

6cac8ef

…n.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

mintlify bot deployed to staging October 2, 2025 06:54 View deployment

stefanjudis and others added 2 commits October 2, 2025 08:54

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

0dae313

…n.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

2c65c23

…n.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

mintlify bot deployed to staging October 2, 2025 06:54 View deployment

mintlify bot deployed to staging October 2, 2025 06:55 View deployment

Update detect/synthetic-monitoring/playwright-checks/configuration.mdx

57afccf

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

stefanjudis requested a review from Copilot October 2, 2025 06:55

mintlify bot deployed to staging October 2, 2025 06:55 View deployment

Copilot AI reviewed Oct 2, 2025

View reviewed changes

detect/synthetic-monitoring/playwright-checks/test-organization.mdx Outdated Show resolved Hide resolved

detect/synthetic-monitoring/playwright-checks/test-organization.mdx Outdated Show resolved Hide resolved

mintlify bot deployed to staging October 2, 2025 06:55 View deployment

stefanjudis and others added 2 commits October 2, 2025 08:58

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

3ecabad

…n.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

65c652c

…n.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

stefanjudis requested a review from Copilot October 2, 2025 06:58

mintlify bot deployed to staging October 2, 2025 06:59 View deployment

Copilot AI reviewed Oct 2, 2025

View reviewed changes

Fix typos

9acb7a8

mintlify bot deployed to staging October 2, 2025 07:14 View deployment

MariadeAnton reviewed Oct 6, 2025

View reviewed changes

stefanjudis and others added 2 commits October 6, 2025 17:22

Update detect/synthetic-monitoring/playwright-checks/configuration.mdx

6e7a038

Co-authored-by: María de Antón <maria@checklyhq.com>

Update detect/synthetic-monitoring/playwright-checks/configuration.mdx

6684e6c

Co-authored-by: María de Antón <maria@checklyhq.com>

mintlify bot deployed to staging October 6, 2025 15:44 View deployment

Adjust PWN code snippet

54944c8

mintlify bot deployed to staging October 6, 2025 15:47 View deployment

stefanjudis and others added 2 commits October 6, 2025 17:47

Update detect/synthetic-monitoring/playwright-checks/configuration.mdx

6cf6db9

Co-authored-by: María de Antón <maria@checklyhq.com>

Update detect/synthetic-monitoring/playwright-checks/configuration.mdx

c838320

Co-authored-by: María de Antón <maria@checklyhq.com>

mintlify bot deployed to staging October 6, 2025 15:48 View deployment

stefanjudis added 2 commits October 6, 2025 17:53

Update screenshot

efba843

Merge branch 'pwn-ga-launch-overhaul' of github.com:checkly/docs into…

0eb700d

… pwn-ga-launch-overhaul

mintlify bot deployed to staging October 6, 2025 15:56 View deployment

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

76eda1d

…n.mdx Co-authored-by: María de Antón <maria@checklyhq.com>

mintlify bot deployed to staging October 6, 2025 16:01 View deployment

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

9cd1c0f

…n.mdx Co-authored-by: María de Antón <maria@checklyhq.com>

mintlify bot deployed to staging October 6, 2025 16:02 View deployment

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

ddfa10f

…n.mdx Co-authored-by: María de Antón <maria@checklyhq.com>

mintlify bot deployed to staging October 6, 2025 16:15 View deployment

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

f157094

…n.mdx Co-authored-by: María de Antón <maria@checklyhq.com>

mintlify bot deployed to staging October 6, 2025 16:17 View deployment

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

f0c2a82

…n.mdx Co-authored-by: María de Antón <maria@checklyhq.com>

mintlify bot deployed to staging October 6, 2025 16:18 View deployment

stefanjudis and others added 2 commits October 6, 2025 18:18

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

de7f981

…n.mdx Co-authored-by: María de Antón <maria@checklyhq.com>

Update detect/synthetic-monitoring/playwright-checks/test-organizatio…

f3acd44

…n.mdx Co-authored-by: María de Antón <maria@checklyhq.com>

mintlify bot deployed to staging October 6, 2025 16:19 View deployment

stefanjudis added 3 commits October 6, 2025 18:20

Update PWN docs

48f2143

Merge branch 'pwn-ga-launch-overhaul' of github.com:checkly/docs into…

ee8dcb6

… pwn-ga-launch-overhaul

Update wording in PWN docs

138e422

mintlify bot deployed to staging October 6, 2025 16:22 View deployment

MariadeAnton approved these changes Oct 6, 2025

View reviewed changes

stefanjudis merged commit e7f2b44 into main Oct 6, 2025
3 checks passed

		// Pick the Playwright project for the staging environment
		pwProjects: ["user-sign-up"],

	During the Beta, a Playwright Check Suite can run up to 20 minutes. This limit can be adjusted based on feedback.
	A Playwright Check Suite can run up to 15 minutes. Please contact us if you're interested in longer runs.


		And configure different monitoring configuration for each Playwright project in your Playwright Check Suite.

		```typescript checkly.config.ts highlight={8-12, 17-21}

Improve Playwright Check Suites docs #48

Improve Playwright Check Suites docs #48

Uh oh!

Conversation

stefanjudis commented Oct 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Copilot AI Oct 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MariadeAnton left a comment

Choose a reason for hiding this comment

Uh oh!

MariadeAnton Oct 2, 2025

Choose a reason for hiding this comment

Uh oh!

MariadeAnton Oct 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MariadeAnton Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

stefanjudis Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MariadeAnton left a comment

Choose a reason for hiding this comment

Uh oh!

MariadeAnton Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!