@serenity-js/web 3.25.0 → 3.25.2

package/src/screenplay/interactions/Press.ts

@@ -8,16 +8,16 @@ import { Key } 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 send a key press or a sequence of keys to a Web element.
  *
  * **Note:** On macOS, some keyboard shortcuts might not work
  * with the [`devtools` protocol](https://webdriver.io/docs/automationProtocols/#devtools-protocol).
  *
  *  For example:
- *  - to *copy*, instead of {@apilink Key.Meta}+`C`, use {@apilink Key.Control}+{@apilink Key.Insert}
- *  - to *cut*, instead of {@apilink Key.Meta}+`X`, use {@apilink Key.Control}+{@apilink Key.Delete}
- *  - to *paste*, instead of {@apilink Key.Meta}+`V`, use {@apilink Key.Shift}+{@apilink Key.Insert}
+ *  - to *copy*, instead of [`Key.Meta`](https://serenity-js.org/api/web/class/Key/#Meta)+`C`, use [`Key.Control`](https://serenity-js.org/api/web/class/Key/#Control)+[`Key.Insert`](https://serenity-js.org/api/web/class/Key/#Insert)
+ *  - to *cut*, instead of [`Key.Meta`](https://serenity-js.org/api/web/class/Key/#Meta)+`X`, use [`Key.Control`](https://serenity-js.org/api/web/class/Key/#Control)+[`Key.Delete`](https://serenity-js.org/api/web/class/Key/#Delete)
+ *  - to *paste*, instead of [`Key.Meta`](https://serenity-js.org/api/web/class/Key/#Meta)+`V`, use [`Key.Shift`](https://serenity-js.org/api/web/class/Key/#Shift)+[`Key.Insert`](https://serenity-js.org/api/web/class/Key/#Insert)
  *
  * ## Example widget
  *
@@ -55,18 +55,18 @@ import { PageElementInteraction } from './PageElementInteraction';
  *
  * ## Learn more
  *
- * - {@apilink Key}
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
+ * - [`Key`](https://serenity-js.org/api/web/class/Key/)
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 export class Press extends PageElementInteraction {
 
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
-     * to press a sequence of {@apilink Key|keys},
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
+     * to press a sequence of [keys](https://serenity-js.org/api/web/class/Key/),
      *
      * When no `field` is specified, the key sequence will be sent to the currently focused element,
      * and if no element is focused - to the `document.body` to handle.

package/src/screenplay/interactions/RightClick.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 right 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 right click on a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * This is typically used to open a [custom context menu](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event)
  * on a given Web element, since it's not possible to interact with the standard context menu offered by your browser.
@@ -63,14 +63,14 @@ 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 RightClick extends PageElementInteraction {
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param pageElement
      *  The element to be right-clicked on

package/src/screenplay/interactions/Scroll.ts

@@ -4,8 +4,8 @@ import { Interaction, the } from '@serenity-js/core';
 import type { PageElement } from '../models';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to scroll until a given {@apilink PageElement} comes into view.
+ * 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 until a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) comes into view.
  *
  * ## Example widget
  *
@@ -45,15 +45,15 @@ import type { PageElement } from '../models';
  *
  * ## 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 Scroll extends Interaction {
 
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param pageElement
      *  The element to scroll to

package/src/screenplay/interactions/Select.ts

@@ -6,20 +6,20 @@ import type { PageElement } from '../models';
 import { SelectOption } from '../models';
 
 /**
- * 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 select an option from a [HTML `<select>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select),
  * either by its display name, or by value.
  *
  * ## Learn more
- * - {@apilink Selected}
+ * - [`Selected`](https://serenity-js.org/api/web/class/Selected/)
  *
  * @group Activities
  */
 export class Select {
 
     /**
-     * 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 select a single [`<option>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * with a given [`value`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option#attr-value).,
      *
@@ -60,12 +60,12 @@ export class Select {
      * ```
      *
      * #### Learn more
-     * - {@apilink Selected.valueOf}
-     * - {@apilink PageElement}
+     * - [`Selected.valueOf`](https://serenity-js.org/api/web/class/Selected/#valueOf)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param value
      *  A value of the [`option` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static value(value: Answerable<string>): { from: (pageElement: Answerable<PageElement>) => Interaction } {
         return {
@@ -80,8 +80,8 @@ export class Select {
     }
 
     /**
-     * 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 select multiple [`<option>` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * identified by their [`value`s](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option#attr-value).
      *
@@ -123,12 +123,12 @@ export class Select {
      *
      * #### Learn more
      *
-     * - {@apilink Selected.valuesOf}
-     * - {@apilink PageElement}
+     * - [`Selected.valuesOf`](https://serenity-js.org/api/web/class/Selected/#valuesOf)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param values
      *  Values of the [`option` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static values(...values: Array<Answerable<string[] | string>>): { from: (pageElement: Answerable<PageElement>) => Interaction } {
         return {
@@ -146,8 +146,8 @@ export class Select {
     }
 
     /**
-     * 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 select a single [`<option>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * with a given description.
      *
@@ -191,12 +191,12 @@ export class Select {
      * ```
      *
      * #### Learn more
-     * - {@apilink Selected.optionIn}
-     * - {@apilink PageElement}
+     * - [`Selected.optionIn`](https://serenity-js.org/api/web/class/Selected/#optionIn)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param value
      *  Text of the [`option` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static option(value: Answerable<string>): { from: (pageElement: Answerable<PageElement>) => Interaction } {
         return {
@@ -211,8 +211,8 @@ export class Select {
     }
 
     /**
-     * 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 select multiple [`<option>` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * identified by their descriptions.
      *
@@ -257,12 +257,12 @@ export class Select {
      * ```
      *
      * #### Learn more
-     * - {@apilink Selected.optionsIn}
-     * - {@apilink PageElement}
+     * - [`Selected.optionsIn`](https://serenity-js.org/api/web/class/Selected/#optionsIn)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param values
      *  Text of the [`option` elements  ](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static options(...values: Array<Answerable<string[] | string>>): { from: (pageElement: Answerable<PageElement>) => Interaction } {
         return {

package/src/screenplay/interactions/Switch.ts

@@ -4,17 +4,17 @@ import { Interaction, Task, the } from '@serenity-js/core';
 import type { Switchable } from '../models';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to switch the context for future activities to a {@apilink Switchable}, such as a {@apilink Page} or a {@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 switch the context for future activities to a [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/), such as a [`Page`](https://serenity-js.org/api/web/class/Page/) or a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
- * Please note that when the {@apilink PageElement} implementing {@apilink Switchable} represents an {@apilink iframe},
- * using {@apilink Switch} will result in switching the top-level browsing context to that {@apilink iframe}.
+ * Please note that when the [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) implementing [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/) represents an [`iframe`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe),
+ * using [`Switch`](https://serenity-js.org/api/web/class/Switch/) will result in switching the top-level browsing context to that [`iframe`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe).
  *
- * When the {@apilink PageElement} represents any other [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement),
- * using {@apilink Switch} sets [`HTMLElement#focus`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus)
+ * When the [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) represents any other [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement),
+ * using [`Switch`](https://serenity-js.org/api/web/class/Switch/) sets [`HTMLElement#focus`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus)
  * on the specified element. Assuming it can be focused.
  *
- * **Note:** The focused element is the element which will receive keyboard {@apilink Press} events by default.
+ * **Note:** The focused element is the element which will receive keyboard [press](https://serenity-js.org/api/web/class/Press/) events by default.
  *
  * ## Perform activities in the context of an iframe
  *
@@ -97,18 +97,18 @@ import type { Switchable } from '../models';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink Switchable}
- * - {@apilink SwitchableOrigin}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
+ * - [`SwitchableOrigin`](https://serenity-js.org/api/web/interface/SwitchableOrigin/)
  *
  * @group Activities
  */
 export class Switch extends Interaction {
 
     /**
-     * Instructs the {@apilink Actor}
-     * to switch the context for future activities to a {@apilink Switchable},
-     * such as a {@apilink Page} or a {@apilink PageElement}.
+     * Instructs the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     * to switch the context for future activities to a [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/),
+     * such as a [`Page`](https://serenity-js.org/api/web/class/Page/) or a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
      *
      * @param switchable
      */
@@ -121,9 +121,9 @@ export class Switch extends Interaction {
     }
 
     /**
-     * Instructs the {@apilink Actor}
-     * to switch the context for future activities to a {@apilink Switchable},
-     * such as a {@apilink Page} or a {@apilink PageElement},
+     * Instructs the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     * to switch the context for future activities to a [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/),
+     * such as a [`Page`](https://serenity-js.org/api/web/class/Page/) or a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/),
      * perform a sequence of `activities`, and then switch the context back.
      *
      * @param activities

package/src/screenplay/interactions/TakeScreenshot.ts

@@ -5,10 +5,12 @@ import { Name, Photo } from '@serenity-js/core/lib/model';
 import { BrowseTheWeb } from '../abilities';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to take a screenshot and emit an {@apilink Artifact},
- * which can then be persisted by {@apilink ArtifactArchiver}
- * and reported by [Serenity BDD reporter](/api/serenity-bdd).
+ * 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 take a screenshot and emit an artifact,
+ * which can then be persisted by [`ArtifactArchiver`](https://serenity-js.org/api/core/class/ArtifactArchiver/)
+ * and reported by [Serenity BDD reporter](https://serenity-js.org/api/serenity-bdd).
  *
  * #### Taking a screenshot
  *
@@ -25,20 +27,19 @@ import { BrowseTheWeb } from '../abilities';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink CollectsArtifacts}
- * - {@apilink Artifact}
- * - {@apilink ArtifactArchiver}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`CollectsArtifacts`](https://serenity-js.org/api/core/interface/CollectsArtifacts/)
+ * - [`ArtifactArchiver`](https://serenity-js.org/api/core/class/ArtifactArchiver/)
  *
  * @group Activities
  */
 export class TakeScreenshot extends Interaction {
 
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param name
-     *  The name to give the emitted {@apilink Artifact}
+     *  The name to give the emitted artifact
      */
     static of(name: Answerable<string>): Interaction {
         return new TakeScreenshot(name);

package/src/screenplay/models/BrowserCapabilities.ts

@@ -3,7 +3,7 @@
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb.browserCapabilities}
+ * - [`BrowseTheWeb.browserCapabilities`](https://serenity-js.org/api/web/class/BrowseTheWeb/#browserCapabilities)
  *
  * @group Models
  */

package/src/screenplay/models/BrowsingSession.ts

@@ -27,17 +27,17 @@ export abstract class BrowsingSession<Page_Type extends Page> {
     }
 
     /**
-     * Opens a new browser page and associates it with a {@apilink Page} object.
+     * Opens a new browser page and associates it with a [`Page`](https://serenity-js.org/api/web/class/Page/) object.
      */
     protected abstract registerCurrentPage(): Promise<Page_Type>;
 
     /**
-     * Returns {@apilink BrowserCapabilities|basic meta-data} about the browser associated with this browsing session.
+     * Returns [basic meta-data](https://serenity-js.org/api/web/interface/BrowserCapabilities/) about the browser associated with this browsing session.
      */
     public abstract browserCapabilities(): Promise<BrowserCapabilities>;
 
     /**
-     * Returns a {@apilink Page} representing the currently active top-level browsing context.
+     * Returns a [`Page`](https://serenity-js.org/api/web/class/Page/) representing the currently active top-level browsing context.
      */
     async currentPage(): Promise<Page_Type> {
         if (! this.currentBrowserPage || ! await this.currentBrowserPage.isPresent()) {
@@ -48,7 +48,7 @@ export abstract class BrowsingSession<Page_Type extends Page> {
     }
 
     /**
-     * Registers specified {@apilink Page|pages} to be managed by this {@apilink BrowsingSession}.
+     * Registers specified [pages](https://serenity-js.org/api/web/class/Page/) to be managed by this [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
      *
      * @param pages
      */
@@ -59,7 +59,7 @@ export abstract class BrowsingSession<Page_Type extends Page> {
     }
 
     /**
-     * Informs this {@apilink BrowsingSession} that it should no longer manage {@apilink Page|pages}
+     * Informs this [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/) that it should no longer manage [pages](https://serenity-js.org/api/web/class/Page/)
      * identified by the given `pageIds`.
      *
      * @param pageIds
@@ -71,7 +71,7 @@ export abstract class BrowsingSession<Page_Type extends Page> {
     }
 
     /**
-     * Returns a {@apilink Page|pages} representing all the available
+     * Returns a [pages](https://serenity-js.org/api/web/class/Page/) representing all the available
      * top-level browsing context, e.g. all the open browser tabs.
      */
     async allPages(): Promise<Array<Page_Type>> {
@@ -79,14 +79,14 @@ export abstract class BrowsingSession<Page_Type extends Page> {
     }
 
     /**
-     * Returns the ids of any {@apilink Page|pages} this {@apilink BrowsingSession} is aware of.
+     * Returns the ids of any [pages](https://serenity-js.org/api/web/class/Page/) this [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/) is aware of.
      */
     registeredPageIds(): Array<CorrelationId> {
         return Array.from(this.pages.keys());
     }
 
     /**
-     * Informs the {@apilink BrowsingSession} that the "current page" has changed to `page`.
+     * Informs the [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/) that the "current page" has changed to `page`.
      *
      * Please note that different Web integration tools have a different definition of what a "current page" is.
      * For example, Selenium or WebdriverIO use a single "focused" window that a developer

package/src/screenplay/models/Cookie.ts

@@ -8,7 +8,7 @@ import { BrowseTheWeb } from '../abilities';
 import type { CookieData } from './CookieData';
 
 /**
- * A Screenplay Pattern-style model responsible for managing cookies available to the current {@apilink Page}.
+ * A Screenplay Pattern-style model responsible for managing cookies available to the current [`Page`](https://serenity-js.org/api/web/class/Page/).
  *
  * ## Checking if a cookie exists
  *
@@ -69,15 +69,15 @@ import type { CookieData } from './CookieData';
  * ```
  *
  * ## Learn more
- * - {@apilink CookieData}
- * - {@apilink Page.cookie}
+ * - [`CookieData`](https://serenity-js.org/api/web/interface/CookieData/)
+ * - [`Page.cookie`](https://serenity-js.org/api/web/class/Page/#cookie)
  *
  * @group Models
  */
 export abstract class Cookie implements Optional {
 
     /**
-     * Creates a {@apilink QuestionAdapter} that resolves to {@apilink Cookie} identified by `name`.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`Cookie`](https://serenity-js.org/api/web/class/Cookie/) identified by `name`.
      *
      * @param name
      */
@@ -90,7 +90,7 @@ export abstract class Cookie implements Optional {
     }
 
     /**
-     * Sets a cookie for the current {@apilink Page}. Note that {@apilink CookieData} can be either a plain-old JavaScript object, or an {@apilink Answerable} {@apilink WithAnswerableProperties}.
+     * Sets a cookie for the current [`Page`](https://serenity-js.org/api/web/class/Page/). Note that [`CookieData`](https://serenity-js.org/api/web/interface/CookieData/) can be either a plain-old JavaScript object, or an [`Answerable`](https://serenity-js.org/api/core/#Answerable) [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties).
      *
      * :::info
      * Make sure that the actor performing this interaction is on the page that should receive the cookie.
@@ -122,7 +122,7 @@ export abstract class Cookie implements Optional {
     }
 
     /**
-     * Creates an {@apilink Interaction|interaction} to delete all cookies available to the current {@apilink Page}..
+     * Creates an [interaction](https://serenity-js.org/api/core/class/Interaction/) to delete all cookies available to the current [`Page`](https://serenity-js.org/api/web/class/Page/)..
      */
     static deleteAll(): Interaction {
         return Interaction.where(`#actor deletes all cookies`, async actor => {
@@ -148,7 +148,7 @@ export abstract class Cookie implements Optional {
      * Checks if a given cookie is set.
      *
      * #### Learn more
-     * - {@apilink Optional}
+     * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
      */
     async isPresent(): Promise<boolean> {
         try {
@@ -214,7 +214,7 @@ export abstract class Cookie implements Optional {
      * Returns the expiry date of a given cookie
      *
      * #### Learn more
-     * - {@apilink Timestamp}
+     * - [`Timestamp`](https://serenity-js.org/api/core/class/Timestamp/)
      */
     async expiry(): Promise<Timestamp> {
         const cookie = await this.lazyLoadCookie();
@@ -232,12 +232,12 @@ export abstract class Cookie implements Optional {
      * This method is to be implemented by test integration tool-specific adapters.
      *
      * **Please note**: you don't need to implement any response caching here
-     * since it is covered by {@apilink Cookie.lazyLoadCookie} method.
+     * since it is covered by [`Cookie`](https://serenity-js.org/api/web/class/Cookie/).lazyLoadCookie} method.
      */
     protected abstract read(): Promise<CookieData>;
 
     /**
-     * Invokes {@apilink Cookie.read} and caches the result in memory.
+     * Invokes `Cookie.read` and caches the result in memory.
      */
     private async lazyLoadCookie(): Promise<CookieData> {
         if (! this.cookie) {

package/src/screenplay/models/CookieData.ts

@@ -1,12 +1,12 @@
 import type { Timestamp } from '@serenity-js/core';
 
 /**
- * A data structure describing a {@apilink Cookie} to be set, or one that's been read.
+ * A data structure describing a [`Cookie`](https://serenity-js.org/api/web/class/Cookie/) to be set, or one that's been read.
  *
  * ## Learn more
  *
- * - {@apilink Cookie}
- * - {@apilink Page.cookie}
+ * - [`Cookie`](https://serenity-js.org/api/web/class/Cookie/)
+ * - [`Page.cookie`](https://serenity-js.org/api/web/class/Page/#cookie)
  *
  * @group Models
  */
@@ -35,7 +35,7 @@ export interface CookieData {
     path?: string;
 
     /**
-     * The {@apilink Timestamp} describing the point in time when this cookie expires.
+     * The [timestamp](https://serenity-js.org/api/core/class/Timestamp/) describing the point in time when this cookie expires.
      */
     expiry?: Timestamp;
 

package/src/screenplay/models/Key.ts

@@ -1,13 +1,13 @@
 /**
- * Represents keyboard keys that aren't text, and that can be used with the {@apilink Interaction|interaction} to {@apilink Press}.
+ * Represents keyboard keys that aren't text, and that can be used with the [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Press`](https://serenity-js.org/api/web/class/Press/).
  *
- * **Note:** Modifier keys like {@apilink Key.Shift}, {@apilink Key.Alt} and {@apilink Key.Meta} (a.k.a. "Command" on Mac) will stay pressed,
+ * **Note:** Modifier keys like [`Key.Shift`](https://serenity-js.org/api/web/class/Key/#Shift), [`Key.Alt`](https://serenity-js.org/api/web/class/Key/#Alt) and [`Key.Meta`](https://serenity-js.org/api/web/class/Key/#Meta) (a.k.a. "Command" on Mac) will stay pressed,
  * so there's no need to depress them.
  *
  * ## Learn more
  *
- * - {@apilink Press}
- * - {@apilink Page.sendKeys}
+ * - [`Press`](https://serenity-js.org/api/web/class/Press/)
+ * - [`Page.sendKeys`](https://serenity-js.org/api/web/class/Page/#sendKeys)
  * - [W3C WebDriver Spec: Keyboard Actions](https://w3c.github.io/webdriver/webdriver-spec.html#keyboard-actions)
  * - [Selenium WebDriver: Inputs](https://github.com/SeleniumHQ/selenium/blob/trunk/javascript/node/selenium-webdriver/lib/input.js#L46)
  * - [WebdriverIO: Constants](https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-utils/src/constants.ts#L5)

package/src/screenplay/models/Locator.ts

@@ -7,14 +7,14 @@ import { RootLocator } from './RootLocator';
 import { ByCss, ById, ByTagName, type Selector } from './selectors';
 
 /**
- * {@apilink Locator} uses a {@apilink Selector} to locate a {@apilink PageElement} or {@apilink PageElements}
- * within the {@apilink Page}.
+ * [`Locator`](https://serenity-js.org/api/web/class/Locator/) uses a [`Selector`](https://serenity-js.org/api/web/class/Selector/) to locate a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
+ * within the [`Page`](https://serenity-js.org/api/web/class/Page/).
  *
  * ## Learn more
- * - {@apilink RootLocator}
- * - {@apilink Page.locate}
- * - {@apilink PageElement}
- * - {@apilink PageElements}
+ * - [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/)
+ * - [`Page.locate`](https://serenity-js.org/api/web/class/Page/#locate)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
  *
  * @group Models
  */
@@ -50,10 +50,10 @@ export abstract class Locator<Native_Element_Type, Native_Selector_Type = any>
     abstract locate(child: Locator<Native_Element_Type>): Locator<Native_Element_Type>;
 
     /**
-     * Expresses {@apilink ByCss}, {@apilink ById}, or {@apilink ByTagName} as a {@apilink ByCss} selector.
+     * Expresses [`ByCss`](https://serenity-js.org/api/web/class/ByCss/), [`ById`](https://serenity-js.org/api/web/class/ById/), or [`ByTagName`](https://serenity-js.org/api/web/class/ByTagName/) as a [`ByCss`](https://serenity-js.org/api/web/class/ByCss/) selector.
      *
      * @throws LogicError
-     *  if the `selector` can't be expressed as {@apilink ByCss}
+     *  if the `selector` can't be expressed as [`ByCss`](https://serenity-js.org/api/web/class/ByCss/)
      *
      * @param selector
      * @protected