@serenity-js/web 3.25.0 → 3.25.2

package/src/expectations/isClickable.ts

@@ -9,18 +9,18 @@ const isElementClickable = Expectation.define(
 );
 
 /**
- *  {@apilink Expectation} that an element is clickable, which means it resolves to `true` when:
- *  - the element {@apilink isPresent|is present} in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
- *  - {@apilink PageElement.isClickable} resolves to `true`
+ *  [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) that an element is clickable, which means it resolves to `true` when:
+ *  - the element [is present](https://serenity-js.org/api/assertions/function/isPresent/) in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
+ *  - [`PageElement.isClickable`](https://serenity-js.org/api/web/class/PageElement/#isClickable) resolves to `true`
  *
  *  If the above conditions are not met, the expectation resolves to `false`.
  *
  * ## Learn more
- * - {@apilink PageElement.isClickable}
- * - {@apilink Expectation}
- * - {@apilink Check}
- * - {@apilink Ensure}
- * - {@apilink Wait}
+ * - [`PageElement.isClickable`](https://serenity-js.org/api/web/class/PageElement/#isClickable)
+ * - [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
  *
  * @group Expectations
  */

package/src/expectations/isEnabled.ts

@@ -9,18 +9,18 @@ const isElementEnabled = Expectation.define(
 );
 
 /**
- *  {@apilink Expectation} that an element is enabled, which means it resolves to `true` when:
- *  - the element {@apilink isPresent|is present} in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
- *  - {@apilink PageElement.isEnabled} resolves to `true`
+ *  [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) that an element is enabled, which means it resolves to `true` when:
+ *  - the element [is present](https://serenity-js.org/api/assertions/function/isPresent/) in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
+ *  - [`PageElement.isEnabled`](https://serenity-js.org/api/web/class/PageElement/#isEnabled) resolves to `true`
  *
  *  If the above conditions are not met, the expectation resolves to `false`.
  *
  * ## Learn more
- * - {@apilink PageElement.isEnabled}
- * - {@apilink Expectation}
- * - {@apilink Check}
- * - {@apilink Ensure}
- * - {@apilink Wait}
+ * - [`PageElement.isEnabled`](https://serenity-js.org/api/web/class/PageElement/#isEnabled)
+ * - [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
  *
  * @group Expectations
  */

package/src/expectations/isSelected.ts

@@ -9,18 +9,18 @@ const isElementSelected = Expectation.define(
 );
 
 /**
- *  {@apilink Expectation} that an `<option>` or `<input>` element is selected, which means it resolves to `true` when:
- *  - the element {@apilink isPresent|is present} in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
- *  - {@apilink PageElement.isSelected} resolves to `true`
+ *  [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) that an `<option>` or `<input>` element is selected, which means it resolves to `true` when:
+ *  - the element [is present](https://serenity-js.org/api/assertions/function/isPresent/) in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
+ *  - [`PageElement.isSelected`](https://serenity-js.org/api/web/class/PageElement/#isSelected) resolves to `true`
  *
  *  If the above conditions are not met, the expectation resolves to `false`.
  *
  * ## Learn more
- * - {@apilink PageElement.isSelected}
- * - {@apilink Expectation}
- * - {@apilink Check}
- * - {@apilink Ensure}
- * - {@apilink Wait}
+ * - [`PageElement.isSelected`](https://serenity-js.org/api/web/class/PageElement/#isSelected)
+ * - [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
  *
  * @group Expectations
  */

package/src/expectations/isVisible.ts

@@ -9,18 +9,18 @@ const isElementVisible = Expectation.define(
 );
 
 /**
- *  {@apilink Expectation} that an element is visible, which means it resolves to `true` when:
- *  - the element {@apilink isPresent|is present} in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
- *  - {@apilink PageElement.isVisible} resolves to `true`
+ *  [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) that an element is visible, which means it resolves to `true` when:
+ *  - the element [is present](https://serenity-js.org/api/assertions/function/isPresent/) in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
+ *  - [`PageElement.isVisible`](https://serenity-js.org/api/web/class/PageElement/#isVisible) resolves to `true`
  *
  *  If the above conditions are not met, the expectation resolves to `false`.
  *
  * ## Learn more
- * - {@apilink PageElement.isVisible}
- * - {@apilink Expectation}
- * - {@apilink Check}
- * - {@apilink Ensure}
- * - {@apilink Wait}
+ * - [`PageElement.isVisible`](https://serenity-js.org/api/web/class/PageElement/#isVisible)
+ * - [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
  *
  * @group Expectations
  */

package/src/screenplay/abilities/BrowseTheWeb.ts

@@ -3,22 +3,22 @@ import { Ability } from '@serenity-js/core';
 import type { BrowserCapabilities, BrowsingSession, Page } from '../models';
 
 /**
- * The {@apilink Ability|ability} to `BrowseTheWeb` enables an {@apilink Actor|actor}
- * to {@apilink Interaction|interact with} and {@apilink Question|retrieve information from} Web-based user interfaces.
+ * The [ability](https://serenity-js.org/api/core/class/Ability/) to `BrowseTheWeb` enables an [actor](https://serenity-js.org/api/core/class/Actor/)
+ * to [interact with](https://serenity-js.org/api/core/class/Interaction/) and [retrieve information from](https://serenity-js.org/api/core/class/Question/) Web-based user interfaces.
  *
- * `BrowseTheWeb` wraps test integration tools such as [Playwright](/api/playwright),
- * [Protractor](/api/protractor), or [WebdriverIO](/api/webdriverio),
- * and together with Serenity/JS Web models, such as {@apilink Page} or {@apilink PageElement} - offers a standardised way
+ * `BrowseTheWeb` wraps test integration tools such as [Playwright](https://serenity-js.org/api/playwright),
+ * [Protractor](https://serenity-js.org/api/protractor), or [WebdriverIO](https://serenity-js.org/api/webdriverio),
+ * and together with Serenity/JS Web models, such as [`Page`](https://serenity-js.org/api/web/class/Page/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) - offers a standardised way
  * to write Web-based tests following the Screenplay Pattern.
  *
- * The consistent and portable design of abstractions provided by the [`@serenity-js/web` module](/api/web)
+ * The consistent and portable design of abstractions provided by the [`@serenity-js/web` module](https://serenity-js.org/api/web)
  * also helps to make your tests portable across the various test integration tools and helps to make your test
  * code easier to reuse across projects and teams.
  *
  * ## Giving the actors an ability to `BrowseTheWeb`
  *
- * To give an {@apilink Actor|actor} an ability to `BrowseTheWeb`, provide the **integration tool-specific implementation**
- * via {@apilink Actor.whoCan} in {@apilink Cast.prepare}, or via {@apilink Cast.where}.
+ * To give an [actor](https://serenity-js.org/api/core/class/Actor/) an ability to `BrowseTheWeb`, provide the **integration tool-specific implementation**
+ * via [`Actor.whoCan`](https://serenity-js.org/api/core/class/Actor/#whoCan) in [`Cast.prepare`](https://serenity-js.org/api/core/class/Cast/#prepare), or via [`Cast.where`](https://serenity-js.org/api/core/class/Cast/#where).
  *
  * ```ts
  * import { beforeEach } from 'mocha'
@@ -39,21 +39,23 @@ import type { BrowserCapabilities, BrowsingSession, Page } from '../models';
  *
  * To learn more about using Serenity/JS with your chosen test integration tool, follow their respective documentation:
  *
- * - {@apilink BrowseTheWebWithPlaywright}
- * - {@apilink BrowseTheWebWithProtractor}
- * - {@apilink BrowseTheWebWithWebdriverIO}
+ * - [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
+ * - [`BrowseTheWebWithProtractor`](https://serenity-js.org/api/protractor/class/BrowseTheWebWithProtractor/)
+ * - [`BrowseTheWebWithWebdriverIO`](https://serenity-js.org/api/webdriverio/class/BrowseTheWebWithWebdriverIO/)
  *
  * ## Using the ability to `BrowseTheWeb`
  *
- * To use the ability to `BrowseTheWeb` in a custom {@apilink Interaction} or {@apilink Question}, use the **generic** method {@apilink BrowseTheWeb.as}
+ * To use the ability to `BrowseTheWeb` in a custom [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
+ * or [`Question`](https://serenity-js.org/api/core/class/Question/), use the **generic** method [`BrowseTheWeb.as`](https://serenity-js.org/api/core/class/Ability/#as)
  * to retrieve it.
  *
- * This generic method retrieves the integration tool-specific implementation of {@apilink BrowseTheWeb} present on the {@apilink Actor},
- * such as {@apilink BrowseTheWebWithPlaywright} or {@apilink BrowseTheWebWethWebdriverIO}, using {@apilink Actor.abilityTo}.
+ * This generic method retrieves the integration tool-specific implementation of [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) present on the [`Actor`](https://serenity-js.org/api/core/class/Actor/),
+ * such as [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
+ * or [`BrowseTheWebWithWebdriverIO`](https://serenity-js.org/api/webdriverio/class/BrowseTheWebWithWebdriverIO/), using [`Actor.abilityTo`](https://serenity-js.org/api/core/class/Actor/#abilityTo).
  *
  * This decoupling mechanism helps to make your test code portable across test integration tools,
  * since the only part of your test suite that needs to know about the test integration tool used are the actors.
- * The rest of your test code, so {@apilink Task|tasks}, {@apilink Interaction|interactions}, and {@apilink Question|questions},
+ * The rest of your test code, so [tasks](https://serenity-js.org/api/core/class/Task/), [interactions](https://serenity-js.org/api/core/class/Interaction/), and [questions](https://serenity-js.org/api/core/class/Question/),
  * remain fully agnostic of the underlying tool.
  *
  * ```ts
@@ -71,10 +73,10 @@ import type { BrowserCapabilities, BrowsingSession, Page } from '../models';
  *
  * ### Learn more
  *
- * - {@apilink Ability}
- * - {@apilink Actor.whoCan}
- * - {@apilink Cast.where}
- * - {@apilink Cast.prepare}
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`Actor.whoCan`](https://serenity-js.org/api/core/class/Actor/#whoCan)
+ * - [`Cast.where`](https://serenity-js.org/api/core/class/Cast/#where)
+ * - [`Cast.prepare`](https://serenity-js.org/api/core/class/Cast/#prepare)
  *
  * @group Abilities
  */
@@ -85,22 +87,22 @@ export abstract class BrowseTheWeb<Native_Element_Type = any> extends Ability {
     }
 
     /**
-     * Returns a {@apilink Page} representing the currently active browser tab.
+     * Returns a [`Page`](https://serenity-js.org/api/web/class/Page/) representing the currently active browser tab.
      */
     async currentPage(): Promise<Page<Native_Element_Type>> {
         return this.session.currentPage();
     }
 
     /**
-     * Returns an array of {@apilink Page|pages} representing all the browser tabs
-     * available in the current {@apilink BrowsingSession}.
+     * Returns an array of [pages](https://serenity-js.org/api/web/class/Page/) representing all the browser tabs
+     * available in the current [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
      */
     allPages(): Promise<Array<Page<Native_Element_Type>>> {
         return this.session.allPages();
     }
 
     /**
-     * Returns {@apilink BrowserCapabilities|basic meta-data} about the browser associated with this ability.
+     * Returns [basic meta-data](https://serenity-js.org/api/web/interface/BrowserCapabilities/) about the browser associated with this ability.
      */
     async browserCapabilities(): Promise<BrowserCapabilities> {
         return this.session.browserCapabilities();

package/src/screenplay/interactions/Clear.ts

@@ -5,7 +5,7 @@ import type { PageElement } from '../models';
 import { PageElementInteraction } from './PageElementInteraction';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to clear the `value` of a [form `input` field](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
  *
  * ## Example widget
@@ -48,18 +48,18 @@ import { PageElementInteraction } from './PageElementInteraction';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink Enter}
- * - {@apilink Value}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Enter`](https://serenity-js.org/api/web/class/Enter/)
+ * - [`Value`](https://serenity-js.org/api/web/class/Value/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 export class Clear extends PageElementInteraction {
 
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to clear the value of an input `field`,
      *
      * @param field

package/src/screenplay/interactions/Click.ts

@@ -5,8 +5,8 @@ import type { PageElement } from '../models';
 import { PageElementInteraction } from './PageElementInteraction';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to scroll the given {@apilink PageElement} into view and then [click](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) on it.
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to scroll the given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) into view and then [click](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) on it.
  *
  * ## Example widget
  *
@@ -44,15 +44,15 @@ import { PageElementInteraction } from './PageElementInteraction';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 export class Click extends PageElementInteraction {
 
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param pageElement
      *  The element to be clicked on

package/src/screenplay/interactions/DoubleClick.ts

@@ -5,8 +5,8 @@ import type { PageElement } from '../models';
 import { PageElementInteraction } from './PageElementInteraction';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to perform a double click on a given {@apilink PageElement}.
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to perform a double click on a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * ## Example widget
  * ```html
@@ -67,15 +67,15 @@ import { PageElementInteraction } from './PageElementInteraction';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 export class DoubleClick extends PageElementInteraction {
 
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param pageElement
      *  The element to be double-clicked on

package/src/screenplay/interactions/Enter.ts

@@ -6,7 +6,7 @@ import type { PageElement } from '../models';
 import { PageElementInteraction } from './PageElementInteraction';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to enter a value into a [form `input`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) field.
  *
  * ## Example widget
@@ -43,7 +43,7 @@ import { PageElementInteraction } from './PageElementInteraction';
  * ## Handling sensitive information
  *
  * By design, any data handled by an actor appears in Serenity/JS reports.
- * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use {@apilink Masked}.
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use [`Masked`](https://serenity-js.org/api/core/class/Masked/).
  * 
  * ```ts
  * import { actorCalled, Masked } from '@serenity-js/core'
@@ -59,15 +59,15 @@ import { PageElementInteraction } from './PageElementInteraction';
  * 
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 export class Enter extends PageElementInteraction {
 
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param values
      *  The text value to be entered

package/src/screenplay/interactions/ExecuteScript.ts

@@ -6,20 +6,20 @@ import { Name, TextData } from '@serenity-js/core/lib/model';
 import { BrowseTheWeb } from '../abilities';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to inject a script into the browser and execute it in the context of the current browser tab.
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink LastScriptExecution.result}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`LastScriptExecution.result`](https://serenity-js.org/api/web/class/LastScriptExecution/#result)
  *
  * @group Activities
  */
 export class ExecuteScript {
 
     /**
-     * Instantiates a version of this {@apilink Interaction}
+     * Instantiates a version of this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
      * configured to load a script from `sourceUrl`.
      *
      * @param sourceUrl
@@ -30,7 +30,7 @@ export class ExecuteScript {
     }
 
     /**
-     * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
      * to execute an asynchronous script within the context of the current browser tab.
      *
      * The script fragment will be executed as the body of an anonymous function.
@@ -39,20 +39,20 @@ export class ExecuteScript {
      *
      * Any arguments provided in addition to the script will be included as script arguments and may be referenced
      * using the `arguments` object. Arguments may be a `boolean`, `number`, `string`
-     * or {@apilink PageElement}.
+     * or [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
      * Arrays and objects may also be used as script arguments as long as each item adheres
      * to the types previously mentioned.
      *
-     * Unlike executing synchronous JavaScript with {@apilink ExecuteScript.sync},
+     * Unlike executing synchronous JavaScript with [`ExecuteScript.sync`](https://serenity-js.org/api/web/class/ExecuteScript/#sync),
      * scripts executed with this function must explicitly signal they are finished by invoking the provided callback.
      *
      * This callback will always be injected into the executed function as the last argument,
      * and thus may be referenced with `arguments[arguments.length - 1]`.
      *
      * If the script invokes the `callback` with a return value, this will be made available
-     * via the {@apilink LastScriptExecution.result}.
+     * via the [`LastScriptExecution.result`](https://serenity-js.org/api/web/class/LastScriptExecution/#result).
      *
-     * **Please note** that in order to signal an error in the `script` you need to throw an {@apilink Error}
+     * **Please note** that in order to signal an error in the `script` you need to throw an [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)
      * instead of passing it to the callback function.
      *
      * #### Executing an async script
@@ -111,7 +111,7 @@ export class ExecuteScript {
      *
      * #### Passing PageElement arguments to an async script
      *
-     * Serenity/JS automatically converts {@link PageElement} objects passed as arguments to the script
+     * Serenity/JS automatically converts [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects passed as arguments to the script
      * into their corresponding DOM elements.
      *
      * ```ts
@@ -135,7 +135,7 @@ export class ExecuteScript {
      *
      * #### Using nested data structures containing PageElement objects
      *
-     * Serenity/JS automatically converts any {@link PageElement} objects
+     * Serenity/JS automatically converts any [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects
      * contained in nested data structures passed to the script
      * into their corresponding DOM elements.
      *
@@ -165,7 +165,7 @@ export class ExecuteScript {
      * ```
      *
      * #### Learn more
-     * - {@apilink LastScriptExecution.result}
+     * - [`LastScriptExecution.result`](https://serenity-js.org/api/web/class/LastScriptExecution/#result)
      *
      * @param script
      *  The script to be executed
@@ -178,10 +178,10 @@ export class ExecuteScript {
     }
 
     /**
-     * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
      * to execute a synchronous script within the context of the current browser tab.
      *
-     * If the script returns a value, it will be made available via {@apilink LastScriptExecution.result}.
+     * If the script returns a value, it will be made available via [`LastScriptExecution.result`](https://serenity-js.org/api/web/class/LastScriptExecution/#result).
      *
      * #### Executing a sync script as string and reading the result
      *
@@ -229,7 +229,7 @@ export class ExecuteScript {
      *
      * #### Passing PageElement arguments to a sync script
      *
-     * Serenity/JS automatically converts {@link PageElement} objects passed as arguments to the script
+     * Serenity/JS automatically converts [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects passed as arguments to the script
      * into their corresponding DOM elements.
      *
      * ```ts
@@ -250,7 +250,7 @@ export class ExecuteScript {
      *
      * #### Using nested data structures containing PageElement objects
      *
-     * Serenity/JS automatically converts any {@link PageElement} objects
+     * Serenity/JS automatically converts any [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects
      * contained in nested data structures passed to the script
      * into their corresponding DOM elements.
      *
@@ -277,7 +277,7 @@ export class ExecuteScript {
      * ```
      *
      * #### Learn more
-     * - {@apilink LastScriptExecution.result}
+     * - [`LastScriptExecution.result`](https://serenity-js.org/api/web/class/LastScriptExecution/#result)
      *
      * @param script
      *  The script to be executed
@@ -294,7 +294,7 @@ export class ExecuteScript {
  * Allows for a script to be executed to be parametrised.
  *
  * ## Learn more
- * -  {@apilink ExecuteScript}
+ * -  [`ExecuteScript`](https://serenity-js.org/api/web/class/ExecuteScript/)
  *
  * @group Activities
  */
@@ -309,7 +309,7 @@ export abstract class ExecuteScriptWithArguments extends Interaction {
     }
 
     /**
-     * Instantiates this {@apilink Interaction}
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
      *
      * @param args
      *  Arguments to parametrise the script with

package/src/screenplay/interactions/Hover.ts

@@ -5,8 +5,8 @@ import type { PageElement } from '../models';
 import { PageElementInteraction } from './PageElementInteraction';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to hover the mouse pointer over a given {@apilink PageElement}.
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to hover the mouse pointer over a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * ## Example widget
  * ```html
@@ -48,15 +48,15 @@ import { PageElementInteraction } from './PageElementInteraction';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 export class Hover extends PageElementInteraction {
 
     /**
-     * Instantiates this {@apilink Interaction}
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
      *
      * @param pageElement
      *  The element to be hovered over

package/src/screenplay/interactions/Navigate.ts

@@ -4,20 +4,20 @@ import { Interaction, TestCompromisedError, the } from '@serenity-js/core';
 import { BrowseTheWeb } from '../abilities';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to navigate to a specific destination, as well as back and forth in the browser history,
  * or reload the current page.
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  *
  * @group Activities
  */
 export class Navigate {
 
     /**
-     * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
      * to navigate to a given URL.
      *
      * The URL can be:
@@ -55,14 +55,14 @@ export class Navigate {
      *
      * #### Learn more
      *
-     * - {@apilink Page.navigateTo}
+     * - [`Page.navigateTo`](https://serenity-js.org/api/web/class/Page/#navigateTo)
      * - [WebdriverIO: Configuration Options](https://webdriver.io/docs/options/#baseurl)
      * - [Playwright: Browser](https://playwright.dev/docs/api/class-browser#browser-new-context)
      * - [Playwright: Test Options](https://playwright.dev/docs/api/class-testoptions#test-options-base-url)
      * - [Protractor: Configuration](https://github.com/angular/protractor/blob/master/lib/config.ts)
      *
      * @param url
-     *  An absolute URL or path an {@apilink Actor}
+     *  An absolute URL or path an [`Actor`](https://serenity-js.org/api/core/class/Actor/)
      *  should navigate to
      */
     static to(url: Answerable<string>): Interaction {
@@ -70,7 +70,7 @@ export class Navigate {
     }
 
     /**
-     * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
      * to navigate back one page in the joint session history of the current top-level browsing context.
      *
      * #### Navigate back in browsing history
@@ -101,7 +101,7 @@ export class Navigate {
     }
 
     /**
-     * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
      * to navigate forward one page in the joint session history of the current top-level browsing context.
      *
      * #### Navigate forward in browsing history
@@ -133,7 +133,7 @@ export class Navigate {
     }
 
     /**
-     * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
      * to reload the current page.
      *
      * #### Navigate to path relative to baseUrl

package/src/screenplay/interactions/PageElementInteraction.ts

@@ -5,10 +5,10 @@ import type { FileSystemLocation } from '@serenity-js/core/lib/io';
 import type { PageElement } from '../models';
 
 /**
- * A base class for interactions with {@apilink PageElement} objects.
+ * A base class for interactions with [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects.
  *
  * **Note:** The recommended way to implement custom interactions
- * in your code is to use the {@apilink Interaction.where} factory method.
+ * in your code is to use the [`Interaction.where`](https://serenity-js.org/api/core/class/Interaction/#where) factory method.
  *
  * @group Activities
  */
@@ -19,7 +19,7 @@ export abstract class PageElementInteraction extends Interaction {
     }
 
     /**
-     * Returns the resolved {@apilink PageElement}, or throws a {@apilink LogicError}
+     * Returns the resolved [`PageElement`](https://serenity-js.org/api/web/class/PageElement/), or throws a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      * if the element is `undefined`.
      *
      * @param actor