@serenity-js/web 3.25.0 → 3.25.1

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

package/src/screenplay/models/Page.ts

@@ -123,17 +123,17 @@ import type { SwitchableOrigin } from './SwitchableOrigin';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
- * - {@apilink Optional}
- * - {@apilink Switchable}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
  *
  * @group Models
  */
 export abstract class Page<Native_Element_Type = any> implements Optional, Switchable {
 
     /**
-     * Creates a {@apilink QuestionAdapter} representing the currently active {@apilink Page}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) representing the currently active [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     static current(): QuestionAdapter<Page> {
         return Question.about<Page>('current page', actor => {
@@ -142,8 +142,8 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
     }
 
     /**
-     * Creates a {@apilink QuestionAdapter} that resolves to a {@apilink Page} which {@apilink Page.name}
-     * meets the {@apilink Expectation|`expectation`}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to a [`Page`](https://serenity-js.org/api/web/class/Page/) which [`Page.name`](https://serenity-js.org/api/web/class/Page/#name)
+     * meets the [expectation](https://serenity-js.org/api/core/class/Expectation/).
      *
      * #### Switching to a page with the desired name
      *
@@ -172,8 +172,8 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
     }
 
     /**
-     * Creates a {@apilink QuestionAdapter} that resolves to a {@apilink Page} which {@apilink Page.title}
-     * meets the {@apilink Expectation|`expectation`}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to a [`Page`](https://serenity-js.org/api/web/class/Page/) which [`Page.title`](https://serenity-js.org/api/web/class/Page/#title)
+     * meets the [expectation](https://serenity-js.org/api/core/class/Expectation/).
      *
      * #### Switching to a page with the desired title
      *
@@ -202,8 +202,8 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
     }
 
     /**
-     * Creates a {@apilink QuestionAdapter} that resolves to a {@apilink Page} which {@apilink Page.url}
-     * meets the {@apilink Expectation|`expectation`}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to a [`Page`](https://serenity-js.org/api/web/class/Page/) which [`Page.url`](https://serenity-js.org/api/web/class/Page/#url)
+     * meets the [expectation](https://serenity-js.org/api/core/class/Expectation/).
      *
      * #### Switching to a page with the desired URL
      *
@@ -258,21 +258,21 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
     }
 
     /**
-     * Creates a {@apilink PageElement} wrapping a native element.
+     * Creates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) wrapping a native element.
      *
      * @param nativeElement
      */
     abstract createPageElement(nativeElement: Native_Element_Type): PageElement<Native_Element_Type>;
 
     /**
-     * Creates a {@apilink PageElement}, retrieving an element located by {@apilink Selector}.
+     * Creates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/), retrieving an element located by [`Selector`](https://serenity-js.org/api/web/class/Selector/).
      *
      * @param selector
      */
     abstract locate(selector: Selector): PageElement<Native_Element_Type>;
 
     /**
-     * Creates {@apilink PageElements}, retrieving a collection of elements located by {@apilink Selector}.
+     * Creates [`PageElement`](https://serenity-js.org/api/web/class/PageElements/), retrieving a collection of elements located by [`Selector`](https://serenity-js.org/api/web/class/Selector/).
      *
      * @param selector
      */
@@ -296,7 +296,7 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
 
     /**
      * Causes the browser to traverse one step backward in the joint session history
-     * of the current {@apilink Page} (the current top-level browsing context).
+     * of the current [`Page`](https://serenity-js.org/api/web/class/Page/) (the current top-level browsing context).
      *
      * This is equivalent to pressing the back button in the browser UI,
      * or calling [`window.history.back`](https://developer.mozilla.org/en-US/docs/Web/API/History/back).
@@ -305,7 +305,7 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
 
     /**
      * Causes the browser to traverse one step forward in the joint session history
-     * of the current {@apilink Page} (the current top-level browsing context).
+     * of the current [`Page`](https://serenity-js.org/api/web/class/Page/) (the current top-level browsing context).
      *
      * This is equivalent to pressing the back button in the browser UI,
      * or calling [`window.history.forward`](https://developer.mozilla.org/en-US/docs/Web/API/History/forward).
@@ -313,12 +313,12 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
     abstract navigateForward(): Promise<void>;
 
     /**
-     * Causes the browser to reload the {@apilink Page} in the current top-level browsing context.
+     * Causes the browser to reload the [`Page`](https://serenity-js.org/api/web/class/Page/) in the current top-level browsing context.
      */
     abstract reload(): Promise<void>;
 
     /**
-     * Send a sequence of {@apilink Key} strokes to the active element.
+     * Send a sequence of [`Key`](https://serenity-js.org/api/web/class/Key/) strokes to the active element.
      *
      * @param keys
      *  Keys to enter
@@ -345,7 +345,7 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
      * If the script has a return value (i.e. if the script contains a `return` statement),
      * then the following steps will be taken for resolving this functions return value:
      *
-     * - For a {@apilink PageElement}, the value will resolve to a [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)
+     * - For a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/), the value will resolve to a [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)
      * - `null` and `undefined` return values will resolve to `null`
      * - `boolean`, `number`, and `string` values will resolve as is
      * - Functions will resolve to their string representation
@@ -363,7 +363,7 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
      *
      * #### Learn more
      * - [Selenium WebDriver: JavaScript Executor](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/JavascriptExecutor.html#executeAsyncScript-java.lang.String-java.lang.Object...-)
-     * - {@apilink Page.lastScriptExecutionResult}
+     * - [`Page.lastScriptExecutionResult`](https://serenity-js.org/api/web/class/Page/#lastScriptExecutionResult)
      *
      * @param script
      * @param args
@@ -385,7 +385,7 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
      * 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 Page.executeScript},
+     * Unlike executing synchronous JavaScript with [`Page.executeScript`](https://serenity-js.org/api/web/class/Page/#executeScript),
      * 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,
@@ -394,7 +394,7 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
      * The following steps will be taken for resolving this functions return value against
      * the first argument to the script's callback function:
      *
-     * - For a {@apilink PageElement}, the value will resolve to a [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)
+     * - For a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/), the value will resolve to a [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)
      * - `null` and `undefined` return values will resolve to `null`
      * - `boolean`, `number`, and `string` values will resolve as is
      * - Functions will resolve to their string representation
@@ -423,7 +423,7 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
      *
      * #### Learn more
      * - [Selenium WebDriver: JavaScript Executor](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/JavascriptExecutor.html#executeAsyncScript-java.lang.String-java.lang.Object...-)
-     * - {@apilink Page.lastScriptExecutionResult}
+     * - [`Page.lastScriptExecutionResult`](https://serenity-js.org/api/web/class/Page/#lastScriptExecutionResult)
      *
      * @param script
      * @param args
@@ -434,15 +434,15 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
     ): Promise<Result>;
 
     /**
-     * Returns the last result of calling {@apilink Page.executeAsyncScript}
-     * or {@apilink Page.executeScript}
+     * Returns the last result of calling [`Page.executeAsyncScript`](https://serenity-js.org/api/web/class/Page/#executeAsyncScript)
+     * or [`Page.executeScript`](https://serenity-js.org/api/web/class/Page/#executeScript)
      */
     abstract lastScriptExecutionResult<R = any>(): R;
 
     /**
      * Take a screenshot of the top-level browsing context's viewport.
      *
-     * @throws {@apilink BrowserWindowClosedError}
+     * @throws [`BrowserWindowClosedError`](https://serenity-js.org/api/web/class/BrowserWindowClosedError/)
      *  When the page you're trying to take the screenshot of has already been closed
      *
      * @return
@@ -451,15 +451,15 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
     abstract takeScreenshot(): Promise<string>;
 
     /**
-     * Retrieves a cookie identified by `name` and visible to this {@apilink Page}.
+     * Retrieves a cookie identified by `name` and visible to this [`Page`](https://serenity-js.org/api/web/class/Page/).
      *
      * @param name
      */
     abstract cookie(name: string): Promise<Cookie>;
 
     /**
-     * Adds a single cookie with {@apilink CookieData} to the cookie store associated
-     * with the active {@apilink Page}'s address.
+     * Adds a single cookie with [`CookieData`](https://serenity-js.org/api/web/interface/CookieData/) to the cookie store associated
+     * with the active [`Page`](https://serenity-js.org/api/web/class/Page/)'s address.
      *
      * @param cookieData
      */
@@ -512,8 +512,8 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
      * to the previous context when needed.
      *
      * ## Learn more
-     * - {@apilink Switch}
-     * - {@apilink Switchable}
+     * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
+     * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
      */
     async switchTo(): Promise<SwitchableOrigin> {
 
@@ -539,7 +539,7 @@ export abstract class Page<Native_Element_Type = any> implements Optional, Switc
     abstract closeOthers(): Promise<void>;
 
     /**
-     * Returns the {@apilink ModalDialogHandler} for the current {@apilink Page}.
+     * Returns the [`ModalDialogHandler`](https://serenity-js.org/api/web/class/ModalDialogHandler/) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     modalDialog(): ModalDialogHandler {
         return this.modalDialogHandler;

package/src/screenplay/models/PageElement.ts

@@ -10,13 +10,13 @@ import type { Switchable } from './Switchable';
 import type { SwitchableOrigin } from './SwitchableOrigin';
 
 /**
- * Uses the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to identify
- * a single Web element located by {@apilink Selector}.
+ * Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to identify
+ * a single Web element located by [`Selector`](https://serenity-js.org/api/web/class/Selector/).
  *
  * ## Learn more
- * - [Page Element Query Language](/handbook/web-testing/page-element-query-language)
- * - {@apilink Optional}
- * - {@apilink Switchable}
+ * - [Page Element Query Language](https://serenity-js.org/handbook/web-testing/page-element-query-language)
+ * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
  *
  * @group Models
  */
@@ -52,7 +52,7 @@ export abstract class PageElement<Native_Element_Type = any> implements Optional
     }
 
     /**
-     * A static method producing a {@apilink MetaQuestion} that can be used with {@apilink PageElements.eachMappedTo} method
+     * A static method producing a [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/) that can be used with [`PageElements.eachMappedTo`](https://serenity-js.org/api/web/class/PageElements/#eachMappedTo) method
      * to extract the HTML of each element in a collection.
      *
      * #### Example
@@ -98,7 +98,7 @@ export abstract class PageElement<Native_Element_Type = any> implements Optional
 
     /**
      * Traverses the element and its parents, heading toward the document root,
-     * until it finds a parent {@apilink PageElement} that matches its associated CSS selector.
+     * until it finds a parent [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) that matches its associated CSS selector.
      *
      * #### Example
      *
@@ -133,9 +133,9 @@ export abstract class PageElement<Native_Element_Type = any> implements Optional
      * :::info
      * This method relies on [Element: closest() API](https://developer.mozilla.org/en-US/docs/Web/API/Element/closest),
      * and so is only compatible with locating parent elements specified using the following CSS selectors:
-     * - {@apilink ByCss}
-     * - {@apilink ById}
-     * - {@apilink ByTagName}
+     * - [`ByCss`](https://serenity-js.org/api/web/class/ByCss/)
+     * - [`ById`](https://serenity-js.org/api/web/class/ById/)
+     * - [`ByTagName`](https://serenity-js.org/api/web/class/ByTagName/)
      * :::
      *
      * @param childElement
@@ -204,8 +204,8 @@ export abstract class PageElement<Native_Element_Type = any> implements Optional
      *  to the previous context if needed.
      *
      * #### Learn more
-     * - {@apilink Switch}
-     * - {@apilink Switchable}
+     * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
+     * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
      */
     abstract switchTo(): Promise<SwitchableOrigin>;
 
@@ -232,7 +232,7 @@ export abstract class PageElement<Native_Element_Type = any> implements Optional
     abstract isEnabled(): Promise<boolean>;
 
     /**
-     * Returns a {@apilink Promise} that resolves to `true` when the element
+     * Returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that resolves to `true` when the element
      * is present in the [Document Object Model (DOM)](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model),
      * `false` otherwise.
      */