@serenity-js/web 3.25.0 → 3.25.1

package/src/screenplay/models/PageElements.ts

@@ -6,15 +6,15 @@ import { PageElementsLocator } from './PageElementsLocator';
 import type { Selector } from './selectors';
 
 /**
- * Uses the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to identify
- * a group of Web elements 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 group of Web elements 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 MetaList}
- * - {@apilink List}
- * - {@apilink ChainableMetaQuestion}
+ * - [Page Element Query Language](https://serenity-js.org/handbook/web-testing/page-element-query-language)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)}
+ * - [`List`](https://serenity-js.org/api/core/class/List/)
+ * - [`ChainableMetaQuestion`](https://serenity-js.org/api/core/interface/ChainableMetaQuestion/)
  *
  * @group Models
  */

package/src/screenplay/models/RootLocator.ts

@@ -3,14 +3,14 @@ import { inspectedObject } from '@serenity-js/core/lib/io';
 import * as util from 'util';   // eslint-disable-line unicorn/import-style
 
 /**
- * {@apilink RootLocator} represents the context in which {@apilink Locator} looks for {@apilink PageElement} or {@apilink PageElements}.
+ * [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/) represents the context in which [`Locator`](https://serenity-js.org/api/web/class/Locator/) looks for [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElements/).
  * This context is either a parent element, or some representation of the top-level browsing context.
  *
  * ## Learn more
- * - {@apilink Locator}
- * - {@apilink Page.locate}
- * - {@apilink PageElement}
- * - {@apilink PageElements}
+ * - [`Locator`](https://serenity-js.org/api/web/class/Locator/)
+ * - [`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
  */

package/src/screenplay/models/SelectOption.ts

@@ -6,10 +6,10 @@ import { TinyType } from 'tiny-types';
  *
  * ## Learn more
  *
- * - {@apilink Select}
- * - {@apilink Selected}
- * - {@apilink PageElement.selectOptions}
- * - {@apilink PageElement.selectedOptions}
+ * - [`Select`](https://serenity-js.org/api/web/class/Select/)
+ * - [`Selected`](https://serenity-js.org/api/web/class/Selected/)
+ * - [`PageElement.selectOptions`](https://serenity-js.org/api/web/class/PageElement/#selectOptions)
+ * - [`PageElement.selectedOptions`](https://serenity-js.org/api/web/class/PageElement/#selectedOptions)
  *
  * @group Models
  */

package/src/screenplay/models/Switchable.ts

@@ -2,14 +2,14 @@ import type { SwitchableOrigin } from './SwitchableOrigin';
 
 /**
  * Describes a Serenity/JS model object that can be switched _to_ and switched back _from_
- * using the {@apilink Task|task} to {@apilink Switch}.
+ * using the [task](https://serenity-js.org/api/core/class/Task/) to [`Switch`](https://serenity-js.org/api/web/class/Switch/).
  *
- * Examples of switchable models include a {@apilink Page} and {@apilink PageElement}.
+ * Examples of switchable models include a [`Page`](https://serenity-js.org/api/web/class/Page/) and [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * ## Learn more
- * - {@apilink Page}
- * - {@apilink PageElement}
- * - {@apilink Switch}
+ * - [`Page`](https://serenity-js.org/api/web/class/Page/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
  *
  * @group Models
  */
@@ -17,7 +17,7 @@ export interface Switchable {
 
     /**
      * Switches the context to the object implementing this interface
-     * and returns {@apilink SwitchableOrigin} that allows for the context to be switched
+     * and returns [`SwitchableOrigin`](https://serenity-js.org/api/web/interface/SwitchableOrigin/) that allows for the context to be switched
      * back when needed.
      */
     switchTo(): Promise<SwitchableOrigin>;

package/src/screenplay/models/SwitchableOrigin.ts

@@ -1,18 +1,18 @@
 /**
- * Enables the {@apilink Task} to {@apilink Switch} to perform a sequence of activities
+ * Enables the [`Task`](https://serenity-js.org/api/core/class/Task/) to [`Switch`](https://serenity-js.org/api/web/class/Switch/) to perform a sequence of activities
  * and switch back to the original context afterwards.
  *
  * ## Learn more
  *
- * - {@apilink Switch}
- * - {@apilink Switchable}
+ * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
  *
  * @group Models
  */
 export interface SwitchableOrigin {
 
     /**
-     * Switches the context back to the original {@apilink Switchable}
+     * Switches the context back to the original [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
      */
     switchBack(): Promise<void>;
 }

package/src/screenplay/models/dialogs/AbsentModalDialog.ts

@@ -4,10 +4,10 @@ import { ModalDialog } from './ModalDialog';
 
 /**
  * `AbsentModalDialog` is a [null object](https://en.wikipedia.org/wiki/Null_object_pattern)
- * representing a {@apilink ModalDialog} that hasn't appeared yet.
+ * representing a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that hasn't appeared yet.
  *
  * ## Learn more
- * - {@apilink ModalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
  *
  * @group Models
  */

package/src/screenplay/models/dialogs/AcceptedModalDialog.ts

@@ -3,11 +3,11 @@ import { ensure, isDefined } from 'tiny-types';
 import { ModalDialog } from './ModalDialog';
 
 /**
- * `AcceptedModalDialog` represents a {@apilink ModalDialog} that has been accepted
- * via {@apilink ModalDialog.acceptNext}.
+ * `AcceptedModalDialog` represents a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that has been accepted
+ * via [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext).
  *
  * ## Learn more
- * - {@apilink ModalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
  *
  * @group Models
  */

package/src/screenplay/models/dialogs/DismissedModalDialog.ts

@@ -3,11 +3,11 @@ import { ensure, isDefined } from 'tiny-types';
 import { ModalDialog } from './ModalDialog';
 
 /**
- * `DismissedModalDialog` represents a {@apilink ModalDialog} that has been dismissed
- * via {@apilink ModalDialog.dismissNext}.
+ * `DismissedModalDialog` represents a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that has been dismissed
+ * via [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext).
  *
  * ## Learn more
- * - {@apilink ModalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
  *
  * @group Models
  */

package/src/screenplay/models/dialogs/ModalDialog.ts

@@ -14,7 +14,10 @@ import { Page } from '../Page';
  * consistent across the various Web integration tools (such as Playwright, Puppeteer,
  * WebdriverIO or Selenium), Serenity/JS works as follows:
  * - Serenity/JS dismisses any modal dialogs by default and stores their message so that it can be asserted on.
- * - This behaviour can be changed by invoking {@apilink ModalDialog.acceptNext}, {@apilink ModalDialog.acceptNextWithValue]], or [[ModalDialog.dismissNext} before the dialog is triggered, as per the below examples.
+ * - This behaviour can be changed by invoking [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext),
+ *   [`ModalDialog.acceptNextWithValue`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNextWithValue),
+ *   or [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext)
+ *   before the dialog is triggered, as per the below examples.
  * - Serenity/JS also allows you to `Wait.until(ModalDialog, isPresent())` so that you can synchronise your tests
  *   with modal dialogs that appear after a delay.
  *
@@ -93,7 +96,7 @@ import { Page } from '../Page';
  * ```
  *
  * ## Learn more
- * - {@apilink Optional}
+ * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
  *
  * @group Models
  */
@@ -126,7 +129,7 @@ export abstract class ModalDialog implements Optional {
     }
 
     /**
-     * Produces an {@apilink Interaction|interaction} that invokes {@apilink ModalDialog.acceptNext}.
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext).
      */
     static acceptNext(): Interaction {
         return Page.current().modalDialog().acceptNext()
@@ -134,7 +137,7 @@ export abstract class ModalDialog implements Optional {
     }
 
     /**
-     * Produces an {@apilink Interaction|interaction} that invokes {@apilink ModalDialog.acceptNextWithValue}.
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.acceptNextWithValue`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNextWithValue).
      *
      * @param value
      */
@@ -144,7 +147,7 @@ export abstract class ModalDialog implements Optional {
     }
 
     /**
-     * Produces an {@apilink Interaction|interaction} that invokes {@apilink ModalDialog.dismissNext}.
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext).
      */
     static dismissNext(): Interaction {
         return Page.current().modalDialog().dismissNext()
@@ -152,7 +155,7 @@ export abstract class ModalDialog implements Optional {
     }
 
     /**
-     * {@apilink QuestionAdapter} that resolves to {@apilink ModalDialog.message} for the current {@apilink Page}.
+     * [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ModalDialog.message`](https://serenity-js.org/api/web/class/ModalDialog/#message) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     static lastDialogMessage(): QuestionAdapter<string> {
         return Page.current().modalDialog().last().message()
@@ -160,7 +163,7 @@ export abstract class ModalDialog implements Optional {
     }
 
     /**
-     * {@apilink QuestionAdapter} that resolves to {@apilink ModalDialog.state} for the current {@apilink Page}.
+     * [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ModalDialog.state`](https://serenity-js.org/api/web/class/ModalDialog/#state) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     static lastDialogState(): QuestionAdapter<string> {
         return Page.current().modalDialog().last().state()
@@ -169,12 +172,12 @@ export abstract class ModalDialog implements Optional {
 
     /**
      * Returns the message of the last modal dialog handled,
-     * or rejects the promise with a {@apilink LogicError}
+     * or rejects the promise with a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      * when no modal dialogs have been observed yet.
      *
      * @returns
      *  Message of the last handled dialog, or a `Promise`
-     *  rejected with a {@apilink LogicError}
+     *  rejected with a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      *  when no dialog has been handled yet.
      */
     abstract message(): Promise<string>;

package/src/screenplay/models/dialogs/ModalDialogHandler.ts

@@ -4,12 +4,12 @@ import { AbsentModalDialog } from './AbsentModalDialog';
 import type { ModalDialog } from './ModalDialog';
 
 /**
- * Represent the strategy to use with any upcoming {@apilink ModalDialog} windows.
+ * Represent the strategy to use with any upcoming [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) windows.
  *
  * ## Learn more
  *
- * - {@apilink ModalDialog}
- * - {@apilink Page.modalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
+ * - [`Page.modalDialog`](https://serenity-js.org/api/web/class/Page/#modalDialog)
  *
  * @group Models
  */
@@ -41,8 +41,8 @@ export abstract class ModalDialogHandler {
     abstract reset(): Promise<void>;
 
     /**
-     * Returns the most recently handled {@apilink ModalDialog},
-     * or {@apilink AbsentModalDialog} when no dialogs have been handled yet.
+     * Returns the most recently handled [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/),
+     * or [`AbsentModalDialog`](https://serenity-js.org/api/web/class/AbsentModalDialog/) when no dialogs have been handled yet.
      */
     async last(): Promise<ModalDialog> {
         return this.modalDialog;

package/src/screenplay/models/selectors/By.ts

@@ -9,8 +9,8 @@ import { ByTagName } from './ByTagName';
 import { ByXPath } from './ByXPath';
 
 /**
- * `By` produces a {@apilink Selector} used to locate a {@apilink PageElement} or {@apilink PageElements} on a web page.
- * Selectors can be defined using a static value or a {@link Question} to be resolved at runtime.
+ * `By` produces a [`Selector`](https://serenity-js.org/api/web/class/Selector/) used to locate a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElements/) on a web page.
+ * Selectors can be defined using a static value or a [`Question`](https://serenity-js.org/api/core/class/Question/) to be resolved at runtime.
  *
  * ### Defining a selector using a static value
  *
@@ -30,11 +30,11 @@ import { ByXPath } from './ByXPath';
  *
  * ### Defining a selector using a Question
  *
- * Each method on this class accepts an {@link Answerable} to allow for dynamic resolution of the selector.
+ * Each method on this class accepts an [`Answerable`](https://serenity-js.org/api/core/#Answerable) to allow for dynamic resolution of the selector.
  * This can be useful when the selector is not known at the time of writing the test, or when the selector
  * needs to be calculated based on the state of the system under test.
  *
- * The example below demonstrates how to use {@link q} to define a selector that includes a dynamic value.
+ * The example below demonstrates how to use [`q`](https://serenity-js.org/api/core/function/q/) to define a selector that includes a dynamic value.
  *
  * ```typescript
  * import { q } from '@serenity-js/core'
@@ -49,17 +49,17 @@ import { ByXPath } from './ByXPath';
  * ```
  *
  * ### Learn more
- * - [Page Element Query Language](/handbook/web-testing/page-element-query-language)
- * - {@apilink PageElement}
- * - {@apilink PageElements}
- * - {@apilink q}
+ * - [Page Element Query Language](https://serenity-js.org/handbook/web-testing/page-element-query-language)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
+ * - [`q`](https://serenity-js.org/api/core/function/q/)
  *
  * @group Models
  */
 export class By {
 
     /**
-     * Locates a {@apilink PageElement} using a [CSS selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors).
+     * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) using a [CSS selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors).
      *
      * @param selector
      */
@@ -71,7 +71,7 @@ export class By {
     }
 
     /**
-     * Locates a {@apilink PageElement} with a given [`innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText)
+     * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) with a given [`innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText)
      * using a [CSS selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors).
      *
      * @param selector
@@ -86,7 +86,7 @@ export class By {
     }
 
     /**
-     * Locates a {@apilink PageElement} using a [CSS selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors)
+     * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) using a [CSS selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors)
      * capable of piercing [shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM)-piercing
      *
      * @param selector
@@ -99,7 +99,7 @@ export class By {
     }
 
     /**
-     * Locates a {@apilink PageElement} using its [id](https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors).
+     * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) using its [id](https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors).
      *
      * @param selector
      */
@@ -111,7 +111,7 @@ export class By {
     }
 
     /**
-     * Locates a {@apilink PageElement} using the name of its [HTML tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element).
+     * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) using the name of its [HTML tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element).
      *
      * @param selector
      */
@@ -123,7 +123,7 @@ export class By {
     }
 
     /**
-     * Locates a {@apilink PageElement} using an [XPath selector](https://developer.mozilla.org/en-US/docs/Web/XPath).
+     * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) using an [XPath selector](https://developer.mozilla.org/en-US/docs/Web/XPath).
      *
      * @param selector
      */

package/src/screenplay/models/selectors/ByCss.ts

@@ -1,9 +1,9 @@
 import { Selector } from './Selector';
 
 /**
- * Locates a {@apilink PageElement} using a [CSS selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors).
+ * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) using a [CSS selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors).
  *
- * **Pro tip:** Instantiate using {@apilink By.css}
+ * **Pro tip:** Instantiate using [`By.css`](https://serenity-js.org/api/web/class/By/#css)
  *
  * @group Models
  */

package/src/screenplay/models/selectors/ByCssContainingText.ts

@@ -1,10 +1,10 @@
 import { Selector } from './Selector';
 
 /**
- * Locates a {@apilink PageElement} with a given [`innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText)
+ * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) with a given [`innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText)
  * using a [CSS selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors).
  *
- * **Pro tip:** Instantiate using {@apilink By.cssContainingText}
+ * **Pro tip:** Instantiate using [`By.cssContainingText`](https://serenity-js.org/api/web/class/By/#cssContainingText)
  *
  * @group Models
  */

package/src/screenplay/models/selectors/ByDeepCss.ts

@@ -1,10 +1,10 @@
 import { Selector } from './Selector';
 
 /**
- * Locates a {@apilink PageElement} using a [CSS selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors)
+ * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) using a [CSS selector](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors)
  * capable of piercing [shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM)-piercing
  *
- * **Pro tip:** Instantiate using {@apilink By.deepCss}
+ * **Pro tip:** Instantiate using [`By.deepCss`](https://serenity-js.org/api/web/class/By/#deepCss)
  *
  * @group Models
  */

package/src/screenplay/models/selectors/ById.ts

@@ -1,9 +1,9 @@
 import { Selector } from './Selector';
 
 /**
- * Locates a {@apilink PageElement} using its [id](https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors).
+ * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) using its [id](https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors).
  *
- * **Pro tip:** Instantiate using {@apilink By.id}
+ * **Pro tip:** Instantiate using [`By.id`](https://serenity-js.org/api/web/class/By/#id)
  *
  * @group Models
  */

package/src/screenplay/models/selectors/ByTagName.ts

@@ -1,9 +1,9 @@
 import { Selector } from './Selector';
 
 /**
- * Locates a {@apilink PageElement} using the name of its [HTML tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element).
+ * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) using the name of its [HTML tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element).
  *
- * **Pro tip:** Instantiate using {@apilink By.tagName}
+ * **Pro tip:** Instantiate using [`By.tagName`](https://serenity-js.org/api/web/class/By/#tagName)
  *
  * @group Models
  */

package/src/screenplay/models/selectors/ByXPath.ts

@@ -1,9 +1,9 @@
 import { Selector } from './Selector';
 
 /**
- * Locates a {@apilink PageElement} using an [XPath selector](https://developer.mozilla.org/en-US/docs/Web/XPath).
+ * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) using an [XPath selector](https://developer.mozilla.org/en-US/docs/Web/XPath).
  *
- * **Pro tip:** Instantiate using {@apilink By.xpath}
+ * **Pro tip:** Instantiate using [`By.xpath`](https://serenity-js.org/api/web/class/By/#xpath)
  *
  * @group Models
  */

package/src/screenplay/models/selectors/Selector.ts

@@ -2,7 +2,7 @@ import { f } from '@serenity-js/core';
 import { TinyType } from 'tiny-types';
 
 /**
- * Describes a selector you use to identify a {@apilink PageElement} or a group of {@apilink PageElements}.
+ * Describes a selector you use to identify a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) or a group of [`PageElement`](https://serenity-js.org/api/web/class/PageElements/).
  *
  * @group Models
  */

package/src/screenplay/questions/Attribute.ts

@@ -4,8 +4,8 @@ import { d, LogicError, Question, the } from '@serenity-js/core';
 import { PageElement } from '../models';
 
 /**
- * Uses the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to retrieve
- * the value of the specified HTML attribute of a given {@apilink PageElement}.
+ * 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 retrieve
+ * the value of the specified HTML attribute of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * ## Example widget
  *
@@ -17,7 +17,7 @@ import { PageElement } from '../models';
  * </ul>
  * ```
  *
- * ## Retrieve an HTML attribute of a given {@apilink PageElement}
+ * ## Retrieve an HTML attribute of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -37,7 +37,7 @@ import { PageElement } from '../models';
  *   )
  * ```
  *
- * ## Using `Attribute` as {@apilink QuestionAdapter}
+ * ## Using `Attribute` as [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -57,7 +57,7 @@ import { PageElement } from '../models';
  * )
  * ```
  *
- * ## Using as filter in {@apilink PageElements|Page Element Query Language}
+ * ## Using as filter in [Page Element Query Language](https://serenity-js.org/handbook/web-testing/page-element-query-language/)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -88,10 +88,10 @@ import { PageElement } from '../models';
  * ```
  *
  * ## Learn more
- * - {@apilink BrowseTheWeb}
- * - {@apilink MetaQuestion}
- * - {@apilink QuestionAdapter}
- * - {@apilink Question}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
+ * - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ * - [`Question`](https://serenity-js.org/api/core/class/Question/)
  *
  * @group Questions
  */
@@ -100,9 +100,9 @@ export class Attribute<Native_Element_Type>
     implements MetaQuestion<PageElement<Native_Element_Type>, Question<Promise<string>>>, Optional
 {
     /**
-     * Instantiates a {@apilink Question} that uses
-     * the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to retrieve
-     * the value of the specified HTML attribute of a given {@apilink PageElement}.
+     * Instantiates a [`Question`](https://serenity-js.org/api/core/class/Question/) that 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 retrieve
+     * the value of the specified HTML attribute of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
      *
      * @param name
      *  The name of the attribute to retrieve
@@ -125,7 +125,7 @@ export class Attribute<Native_Element_Type>
      * Resolves to the value of an HTML attribute of the `pageElement`.
      *
      * #### Learn more
-     * - {@apilink MetaQuestion}
+     * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
      *
      * @param pageElement
      */

package/src/screenplay/questions/ComputedStyle.ts

@@ -12,8 +12,8 @@ import { BrowseTheWeb } from '../abilities';
 import { PageElement } from '../models';
 
 /**
- * Uses the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to retrieve
- * the value of the specified computed style property of a given {@apilink PageElement}.
+ * 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 retrieve
+ * the value of the specified computed style property of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * ## Example widget
  *
@@ -25,7 +25,7 @@ import { PageElement } from '../models';
  * </ul>
  * ```
  *
- * ## Retrieve a computed style property of a given {@apilink PageElement}
+ * ## Retrieve a computed style property of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -44,7 +44,7 @@ import { PageElement } from '../models';
  * )
  * ```
  *
- * ## Using `ComputedStyle` as {@apilink QuestionAdapter}
+ * ## Using `ComputedStyle` as [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -63,7 +63,7 @@ import { PageElement } from '../models';
  * )
  * ```
  *
- * ## Using as filter in {@apilink PageElements|Page Element Query Language}
+ * ## Using as filter in [Page Element Query Language](https://serenity-js.org/handbook/web-testing/page-element-query-language/)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -94,10 +94,10 @@ import { PageElement } from '../models';
  * ```
  *
  * ## Learn more
- * - {@apilink BrowseTheWeb}
- * - {@apilink MetaQuestion}
- * - {@apilink QuestionAdapter}
- * - {@apilink Question}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
+ * - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ * - [`Question`](https://serenity-js.org/api/core/class/Question/)
  *
  * @group Questions
  */
@@ -106,9 +106,9 @@ export class ComputedStyle<Native_Element_Type>
     implements MetaQuestion<PageElement<Native_Element_Type>, Question<Promise<string>>>
 {
     /**
-     * Instantiates a {@apilink Question} that uses
-     * the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to retrieve
-     * the value of the specified computed style property of a given {@apilink PageElement}.
+     * Instantiates a [`Question`](https://serenity-js.org/api/core/class/Question/) that 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 retrieve
+     * the value of the specified computed style property of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
      *
      * @param name
      *  The name of the computed style property to retrieve
@@ -130,9 +130,9 @@ export class ComputedStyle<Native_Element_Type>
     }
 
     /**
-     * Instantiates a {@apilink Question} that uses
-     * the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to retrieve
-     * the value of the specified computed style property of the specified pseudo-element of a given {@apilink PageElement}.
+     * Instantiates a [`Question`](https://serenity-js.org/api/core/class/Question/) that 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 retrieve
+     * the value of the specified computed style property of the specified pseudo-element of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
      *
      * @param pseudoElement
      *  The pseudo-element to retrieve the computed style property from, such as `::before` or `::after`
@@ -151,7 +151,7 @@ export class ComputedStyle<Native_Element_Type>
      * Resolves to the value of a computed style property of the `pageElement`.
      *
      * #### Learn more
-     * - {@apilink MetaQuestion}
+     * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
      *
      * @param pageElement
      */