From 4e663c21f2cb2d929137c33937011a1b4d25d5ea Mon Sep 17 00:00:00 2001
From: MariadeAnton <maria@checklyhq.com>
Date: Fri, 23 May 2025 12:41:57 +0200
Subject: [PATCH] Add new logicalId Fix jiti vs ts-node in onboarding
 description

---
 site/content/docs/playwright-checks/_index.md      | 14 ++++++++------
 .../content/docs/playwright-checks/add-to-group.md |  5 ++++-
 site/content/docs/playwright-checks/reference.md   |  8 +++++++-
 3 files changed, 19 insertions(+), 8 deletions(-)

diff --git a/site/content/docs/playwright-checks/_index.md b/site/content/docs/playwright-checks/_index.md
index 5f722c193..b588a3d46 100644
--- a/site/content/docs/playwright-checks/_index.md
+++ b/site/content/docs/playwright-checks/_index.md
@@ -58,7 +58,7 @@ The alpha version gets updated daily with new improvements. You can follow updat
 
 ### 2. [Optional] If you're using TypeScript
 
-  If you're using TypeScript, install the dev dependencies [`ts-node`](https://www.npmjs.com/package/ts-node) and [`typescript`](https://www.npmjs.com/package/typescript).
+  If you're using TypeScript, install the dev dependencies [`jiti`](https://www.npmjs.com/package/jiti) and [`typescript`](https://www.npmjs.com/package/typescript).
 
   ```bash {title="Terminal"}
   npm install --save-dev jiti typescript
@@ -98,23 +98,25 @@ Here's a fully working example. Adjust the `pwProjects` and `pwTags` to ones tha
         {
           /* Create a multi-browser check that runs 
           every 5 mins.*/
-          name: 'multi-browser',
+          name: 'Multi Browser Suite',
+          logicalId: 'multi-browser',
           pwProjects: ['chromium', 'firefox', 'webkit'], // Reference the project or projects in your playwright config
           frequency: Frequency.EVERY_5M, // set your ideal frequency
           locations: ['us-east-1', 'eu-west-1'], // add your locations
         },
         {
           /* Create a check that runs the critical tagged tests every 10 mins */
-          name: 'checkly-tagged',
-          pwTags: 'checkly', // Reference an existing tag in your tests
+          name: 'Checkly Tagged tests',
+          logicalId: 'checkly-tagged',
+          pwTags: '@checkly', // Reference an existing tag in your tests
           frequency: Frequency.EVERY_10M,  // set your ideal frequency
-          locations: ['eu-west-1'],
+          locations: ['us-east-1'],
         },
       ],
     },
     /* The default location to use when running npx checkly test */
     cli: {
-      runLocation: 'eu-west-1',
+      runLocation: 'us-east-1',
       retries: 0, // full test retries, when running npx checkly test
     },
   })
diff --git a/site/content/docs/playwright-checks/add-to-group.md b/site/content/docs/playwright-checks/add-to-group.md
index a1611654f..5932f9fcf 100644
--- a/site/content/docs/playwright-checks/add-to-group.md
+++ b/site/content/docs/playwright-checks/add-to-group.md
@@ -26,6 +26,7 @@ import { CheckGroup } from 'checkly/constructs'
 
 export const myGroup = new CheckGroup('production-group', {
   name: 'Production group',
+  logicalID: 'production-group',
   activated: true,
   muted: false,
   locations: ['us-east-1', 'eu-west-1'],
@@ -54,7 +55,9 @@ When specifying your Playwright Check Suite, you can reference the new or existi
       playwrightConfigPath: './playwright.config.ts',
       playwrightChecks: [
         {
-          name: 'checkly-website',
+          name: 'Critical Tests',
+          logicalId: 'critical-tests',
+          pwTags:'critical',
           frequency: 10,
           locations: ['us-east-1',],
           groupName: 'Production group', // use the name of the group you created
diff --git a/site/content/docs/playwright-checks/reference.md b/site/content/docs/playwright-checks/reference.md
index 6899ecafd..76d21221f 100644
--- a/site/content/docs/playwright-checks/reference.md
+++ b/site/content/docs/playwright-checks/reference.md
@@ -16,6 +16,11 @@ To define your Playwright Check Suite, you use the `checkly.config.ts/js` file.
 Each Playwright Check Suite is connected to an existing reference in your `playwright.config.ts/js` file. 
 During the Alpha, a Playwright Check Suite can last up to 20 minutes. This limit is open to be increased / decreased after the alpha.
 
+## Playwright Check Suite definition
+
+* `name` - a human friendly name for your check suite.
+* `logicalId` - a reference for your check suite.
+
 ## Playwright references
 
 The following Playwright references are available to create a Playwright Monitor:
@@ -67,7 +72,8 @@ checks: {
    playwrightChecks: [
     {
 	// Run E2E tagged tests across browsers in 4 locations
-	name: 'E2E',
+	name: 'E2E test suite',
+  logicalId: 'e2e-test-suite',
 	pwProjects: ['chromium', 'firefox', 'webkit'], // Reference the project or projects in playwright.config file
 	pwTags: 'e2e', // Reference an existing tag in your tests
 	installCommand: 'npm install --dev', // Optionally override default dependencies install command