Update checkly rules and TS Docs reference docs

eslint.config.mjs

@@ -22,6 +22,7 @@ const checklyStyle = {
         code: 120,
         ignoreTemplateLiterals: true,
         ignoreStrings: true,
+        ignoreComments: true,
       },
     ],
     'no-var': 'error',

packages/cli/src/constructs/alert-channel.ts

@@ -117,8 +117,7 @@ export class AlertChannelRef extends Construct {
  * })
  * ```
  *
- * @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#alertchannel | AlertChannel API Reference}
- * @see {@link https://www.checklyhq.com/docs/alerting-and-retries/alert-channels/ | Alert Channels Documentation}
+ * @see {@link https://www.checklyhq.com/docs/communicate/alerts/channels/ | Alert Channels Documentation}
  */
 export abstract class AlertChannel extends Construct {
   sendRecovery?: boolean

packages/cli/src/constructs/api-assertion.ts

@@ -49,7 +49,7 @@ export type Assertion = CoreAssertion<ApiAssertionSource>
  * ```
  *
  * @see {@link https://jsonpath.com/ | JSONPath Online Evaluator}
- * @see {@link https://www.checklyhq.com/docs/api-checks/assertions/ | API Check Assertions}
+ * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/assertions/ | API Check Assertions}
  */
 // Called AssertionBuilder instead of ApiAssertionBuilder for historical
 // reasons.

packages/cli/src/constructs/api-check.ts

@@ -136,66 +136,8 @@ export interface ApiCheckProps extends RuntimeCheckProps {
  * })
  * ```
  *
- * @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#apicheck | ApiCheck API Reference}
- * @see {@link https://www.checklyhq.com/docs/monitoring/api-checks/ | API Checks Documentation}
- */
-/**
- * Creates an API Check to monitor HTTP endpoints and APIs.
- *
- * API checks allow you to monitor REST APIs, GraphQL endpoints, and any HTTP-based service.
- * You can validate response status codes, response times, headers, and response body content.
- *
- * @example
- * ```typescript
- * // Basic API check
- * new ApiCheck('hello-api', {
- *   name: 'Hello API',
- *   request: {
- *     method: 'GET',
- *     url: 'https://api.example.com/hello',
- *     assertions: [
- *       AssertionBuilder.statusCode().equals(200)
- *     ]
- *   }
- * })
- *
- * // Advanced API check with POST request
- * new ApiCheck('user-api', {
- *   name: 'User API Check',
- *   frequency: Frequency.EVERY_5M,
- *   locations: ['us-east-1', 'eu-west-1'],
- *   request: {
- *     method: 'POST',
- *     url: 'https://api.example.com/users',
- *     headers: [{ key: 'Content-Type', value: 'application/json' }],
- *     body: JSON.stringify({ name: 'test-user' }),
- *     bodyType: 'JSON',
- *     assertions: [
- *       AssertionBuilder.statusCode().equals(201),
- *       AssertionBuilder.jsonBody('$.id').isNotNull(),
- *       AssertionBuilder.responseTime().lessThan(1000)
- *     ]
- *   },
- *   maxResponseTime: 5000,
- *   degradedResponseTime: 2000
- * })
- *
- * // Error validation check (shouldFail required for error status checks)
- * new ApiCheck('not-found-check', {
- *   name: 'Not Found Check',
- *   shouldFail: true,
- *   request: {
- *     method: 'GET',
- *     url: 'https://api.example.com/nonexistent',
- *     assertions: [
- *       AssertionBuilder.statusCode().equals(404)
- *     ]
- *   }
- * })
- * ```
- *
- * @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#apicheck | ApiCheck API Reference}
- * @see {@link https://www.checklyhq.com/docs/monitoring/api-checks/ | API Checks Documentation}
+ * @see {@link https://www.checklyhq.com/docs/constructs/api-check/ | ApiCheck API Reference}
+ * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/overview/ | API Checks Documentation}
  */
 export class ApiCheck extends RuntimeCheck {
   readonly request: Request
@@ -212,7 +154,7 @@ export class ApiCheck extends RuntimeCheck {
    * @param logicalId unique project-scoped resource name identification
    * @param props check configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#apicheck Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/api-check/ Read more in the docs}
    */
 
   constructor (logicalId: string, props: ApiCheckProps) {

packages/cli/src/constructs/browser-check.ts

@@ -72,8 +72,8 @@ export interface BrowserCheckProps extends RuntimeCheckProps {
  * })
  * ```
  *
- * @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#browsercheck | BrowserCheck API Reference}
- * @see {@link https://www.checklyhq.com/docs/monitoring/browser-checks/ | Browser Checks Documentation}
+ * @see {@link https://www.checklyhq.com/docs/constructs/browser-check/ | BrowserCheck API Reference}
+ * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/browser-checks/overview/ | Browser Checks Documentation}
  * @see {@link https://playwright.dev/ | Playwright Documentation}
  */
 export class BrowserCheck extends RuntimeCheck {
@@ -86,7 +86,7 @@ export class BrowserCheck extends RuntimeCheck {
    *
    * @param logicalId unique project-scoped resource name identification
    * @param props check configuration properties
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#browsercheck Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/browser-check/ Read more in the docs}
    */
   constructor (logicalId: string, props: BrowserCheckProps) {
     super(logicalId, props)

packages/cli/src/constructs/check-group-v2.ts

@@ -86,7 +86,7 @@ export interface CheckGroupV2Props extends Omit<CheckGroupV1Props, 'alertEscalat
    *
    * If not set, individual check settings are used.
    *
-   * See https://www.checklyhq.com/docs/monitoring/global-locations/ to learn
+   * See https://www.checklyhq.com/docs/concepts/locations/ to learn
    * more about scheduling strategies.
    */
   runParallel?: boolean

packages/cli/src/constructs/check.ts

@@ -93,7 +93,7 @@ export interface CheckProps {
    * An array of one or more data center locations where to run this check.
    *
    * @example ['us-east-1', 'eu-west-1', 'ap-southeast-1']
-   * @see {@link https://www.checklyhq.com/docs/monitoring/global-locations/ | Global Locations}
+   * @see {@link https://www.checklyhq.com/docs/concepts/locations/ | Global Locations}
    */
   locations?: Array<keyof Region>
 
@@ -174,7 +174,7 @@ export interface CheckProps {
    * // Reference the channels in your check
    * alertChannels: [emailChannel, slackChannel]
    * ```
-   * @see {@link https://www.checklyhq.com/docs/alerting-and-retries/alert-channels/ | Alert Channels}
+   * @see {@link https://www.checklyhq.com/docs/communicate/alerts/channels/ | Alert Channels}
    */
   alertChannels?: Array<AlertChannel | AlertChannelRef>
 
@@ -218,15 +218,15 @@ export interface CheckProps {
    * Determines whether the check should run on all selected locations in parallel or round-robin.
    *
    * @defaultValue false (round-robin)
-   * @see {@link https://www.checklyhq.com/docs/monitoring/global-locations/ | Scheduling Strategies}
+   * @see {@link https://www.checklyhq.com/docs/concepts/scheduling/ | Scheduling Strategies}
    */
   runParallel?: boolean
 
   /**
    * Determines whether the check should create and resolve an incident based on its alert configuration.
    * Useful for status page automation.
    *
-   * @see {@link https://www.checklyhq.com/docs/status-pages/incidents/#incident-automation | Incident Automation}
+   * @see {@link https://www.checklyhq.com/docs/communicate/status-pages/incidents/#incident-automation | Incident Automation}
    */
   triggerIncident?: IncidentTrigger
 }

packages/cli/src/constructs/dashboard.ts

@@ -45,7 +45,7 @@ export interface DashboardProps {
    * This is required if 'customUrl' is not specified.
    *
    * @example 'status.example.com'
-   * @see {@link https://www.checklyhq.com/docs/dashboards/custom-domains/ | Custom Domain Setup}
+   * @see {@link https://www.checklyhq.com/docs/communicate/dashboards/configuration/#custom-domain | Custom Domain Setup}
    */
   customDomain?: string
 
@@ -144,7 +144,7 @@ export interface DashboardProps {
    *
    * @defaultValue false
    * @remarks Only paid accounts can enable this feature
-   * @see {@link https://www.checklyhq.com/docs/dashboards/incidents/ | Dashboard Incidents}
+   * @see {@link https://www.checklyhq.com/docs/communicate/dashboards/incidents/ | Dashboard Incidents}
    */
   enableIncidents?: boolean
 
@@ -244,7 +244,7 @@ export class Dashboard extends Construct {
    * @param logicalId unique project-scoped resource name identification
    * @param props dashboard configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#dashboard Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/dashboard/ Read more in the docs}
    */
   constructor (logicalId: string, props: DashboardProps) {
     super(Dashboard.__checklyType, logicalId)

packages/cli/src/constructs/dns-monitor.ts

@@ -58,7 +58,7 @@ export class DnsMonitor extends Monitor {
    * @param logicalId unique project-scoped resource name identification
    * @param props configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#dnsmonitor Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/dns-monitor/ Read more in the docs}
    */
 
   constructor (logicalId: string, props: DnsMonitorProps) {

packages/cli/src/constructs/email-alert-channel.ts

@@ -22,7 +22,7 @@ export class EmailAlertChannel extends AlertChannel {
    *
    * @param logicalId unique project-scoped resource name identification
    * @param props email alert channel configuration properties
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#emailalertchannel Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/email-alert-channel/ Read more in the docs}
    */
   constructor (logicalId: string, props: EmailAlertChannelProps) {
     super(logicalId, props)

packages/cli/src/constructs/frequency.ts

@@ -14,7 +14,7 @@
  * frequency: Frequency.EVERY_24H
  * ```
  *
- * @see {@link https://www.checklyhq.com/docs/monitoring/ | Monitoring Documentation}
+ * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/overview/ | Monitoring Documentation}
  */
 export class Frequency {
   /** Run every 10 seconds */

packages/cli/src/constructs/heartbeat-monitor.ts

@@ -62,7 +62,7 @@ export class HeartbeatMonitor extends Monitor {
    *
    * @param logicalId unique project-scoped resource name identification
    * @param props configuration properties
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#heartbeatmonitor Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/heartbeat-monitor/ Read more in the docs}
    */
   constructor (logicalId: string, props: HeartbeatMonitorProps) {
     super(logicalId, props)

packages/cli/src/constructs/incidentio-alert-channel.ts

@@ -8,12 +8,12 @@ export interface IncidentioAlertChannelProps extends AlertChannelProps {
   name: string
   /**
    * The unique URL created by installing the Checkly integration in Incident.io.
-   * {@link https://www.checklyhq.com/docs/integrations/incidentio/}
+   * {@link https://www.checklyhq.com/docs/integrations/incident-management/incidentio/}
    */
   url: URL | string
   /**
    * The API key created by installing the Checkly integration in Incident.io.
-   * {@link https://www.checklyhq.com/docs/integrations/incidentio/}
+   * {@link https://www.checklyhq.com/docs/integrations/incident-management/incidentio/}
    */
   apiKey: string
   /**
@@ -54,7 +54,7 @@ export class IncidentioAlertChannel extends WebhookAlertChannel {
    * @param logicalId unique project-scoped resource name identification
    * @param props Incident.io alert channel configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#incidentioalertchannel Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/integrations/incident-management/incidentio/ Read more in the docs}
    */
   constructor (logicalId: string, props: IncidentioAlertChannelProps) {
     super(logicalId, props)

packages/cli/src/constructs/maintenance-window.ts

@@ -60,7 +60,7 @@ export class MaintenanceWindow extends Construct {
    * @param logicalId unique project-scoped resource name identification
    * @param props maintenance window configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#maintenancewindow Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/maintenance-window/ Read more in the docs}
    */
   constructor (logicalId: string, props: MaintenanceWindowProps) {
     super(MaintenanceWindow.__checklyType, logicalId)

packages/cli/src/constructs/monitor.ts

@@ -105,7 +105,7 @@ export interface MonitorProps extends Omit<CheckProps, 'doubleCheck'> {
    * Determines whether the monitor should create and resolve an incident
    * based on its alert configuration.
    *
-   * See https://www.checklyhq.com/docs/status-pages/incidents/#incident-automation
+   * See https://www.checklyhq.com/docs/communicate/status-pages/incidents/#incident-automation
    * to learn more about automated incidents.
    */
   triggerIncident?: IncidentTrigger

packages/cli/src/constructs/msteams-alert-channel.ts

@@ -8,7 +8,7 @@ export interface MSTeamsAlertChannelProps extends AlertChannelProps {
   name: string
   /**
    * The unique URL created by creating an integration in Microsoft Teams.
-   * {@link https://www.checklyhq.com/docs/integrations/msteams/}
+   * {@link https://www.checklyhq.com/docs/integrations/alerts/msteams/}
    */
   url: string
   /**

packages/cli/src/constructs/multi-step-check.ts

@@ -35,7 +35,7 @@ export class MultiStepCheck extends RuntimeCheck {
    *
    * @param logicalId unique project-scoped resource name identification
    * @param props check configuration properties
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#multistepcheck Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/multistep-check/ Read more in the docs}
    */
   constructor (logicalId: string, props: MultiStepCheckProps) {
     super(logicalId, props)

packages/cli/src/constructs/opsgenie-alert-channel.ts

@@ -12,7 +12,8 @@ export interface OpsgenieAlertChannelProps extends AlertChannelProps {
   name: string
   /**
    * An API key for your Opsgenie account. See our
-   * {@link https://www.checklyhq.com/docs/integrations/opsgenie/ docs} on where to create this API key
+   * {@link https://www.checklyhq.com/docs/integrations/incident-management/opsgenie/
+   * docs on where to create this API key}
    */
   apiKey: string
   /**

packages/cli/src/constructs/phone-call-alert-channel.ts

@@ -28,8 +28,8 @@ export class PhoneCallAlertChannel extends AlertChannel {
    * @param logicalId unique project-scoped resource name identification
    * @param props Phone Call alert channel configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#phonecallalertchannel Read more in the docs}
-   * {@link https://checklyhq.com/docs/alerting/phone-calls/#supported-countries-and-regions
+   * {@link https://www.checklyhq.com/docs/constructs/phone-call-alert-channel/ Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/integrations/alerts/phone-calls/#supported-countries-and-regions
    *  List of supported countries}
    */
   constructor (logicalId: string, props: PhoneCallAlertChannelProps) {

packages/cli/src/constructs/playwright-check.ts

@@ -119,8 +119,9 @@ export interface PlaywrightCheckProps extends Omit<RuntimeCheckProps, 'retryStra
  * })
  * ```
  *
- * @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#playwrightcheck | PlaywrightCheck API Reference}
- * @see {@link https://www.checklyhq.com/docs/playwright-checks/ | Playwright Checks Documentation}
+ * @see {@link https://www.checklyhq.com/docs/constructs/playwright-check/ | PlaywrightCheck API Reference}
+ * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/playwright-checks/overview/
+ * Playwright Checks Documentation}
  * @see {@link https://playwright.dev/ | Playwright Documentation}
  */
 export class PlaywrightCheck extends RuntimeCheck {

packages/cli/src/constructs/private-location.ts

@@ -76,7 +76,7 @@ const RE_SLUG = /^((?!((us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|(north|south)?(
  *
  * This class make use of the Private Location endpoints.
  *
- * {@link https://www.checklyhq.com/docs/cli/constructs-reference/#privatelocation Read more in the docs}
+ * {@link https://www.checklyhq.com/docs/constructs/private-location/ Read more in the docs}
  */
 export class PrivateLocation extends Construct {
   name: string

packages/cli/src/constructs/slack-alert-channel.ts

@@ -22,7 +22,7 @@ export class SlackAlertChannel extends AlertChannel {
    * @param logicalId unique project-scoped resource name identification
    * @param props Slack alert channel configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#slackalertchannel Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/slack-alert-channel/ Read more in the docs}
    */
   constructor (logicalId: string, props: SlackAlertChannelProps) {
     super(logicalId, props)

packages/cli/src/constructs/sms-alert-channel.ts

@@ -28,7 +28,7 @@ export class SmsAlertChannel extends AlertChannel {
    * @param logicalId unique project-scoped resource name identification
    * @param props SMS alert channel configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#smsalertchannel Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/sms-alert-channel/ Read more in the docs}
    */
   constructor (logicalId: string, props: SmsAlertChannelProps) {
     super(logicalId, props)

packages/cli/src/constructs/status-page-service.ts

@@ -42,7 +42,7 @@ export class StatusPageService extends Construct {
    * @param logicalId unique project-scoped resource name identification
    * @param props status page service configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#statuspageservice Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/status-page-service/ Read more in the docs}
    */
   constructor (logicalId: string, props: StatusPageServiceProps) {
     super(StatusPageService.__checklyType, logicalId)

packages/cli/src/constructs/status-page.ts

@@ -72,7 +72,7 @@ export class StatusPage extends Construct {
    * @param logicalId unique project-scoped resource name identification
    * @param props status page configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#statuspage Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/status-page/ Read more in the docs}
    */
   constructor (logicalId: string, props: StatusPageProps) {
     super(StatusPage.__checklyType, logicalId)

packages/cli/src/constructs/tcp-monitor.ts

@@ -136,7 +136,7 @@ export class TcpMonitor extends Monitor {
    * @param logicalId unique project-scoped resource name identification
    * @param props configuration properties
    *
-   * {@link https://checklyhq.com/docs/cli/constructs-reference/#tcpmonitor Read more in the docs}
+   * {@link https://www.checklyhq.com/docs/constructs/tcp-monitor/ Read more in the docs}
    */
 
   constructor (logicalId: string, props: TcpMonitorProps) {

packages/cli/src/constructs/telegram-alert-channel.ts

@@ -8,12 +8,12 @@ export interface TelegramAlertChannelProps extends AlertChannelProps {
   name: string
   /**
    * The chat ID of your Telegram bot.
-   * {@link https://www.checklyhq.com/docs/integrations/telegram/}
+   * {@link https://www.checklyhq.com/docs/integrations/alerts/telegram/}
    */
   chatId: string
   /**
    * The API key for your Telegram bot.
-   * {@link https://www.checklyhq.com/docs/integrations/telegram/}
+   * {@link https://www.checklyhq.com/docs/integrations/alerts/telegram/}
    */
   apiKey: string
   /**