@serenity-js/core 3.25.0 → 3.25.1

package/src/screenplay/debugging/Log.ts

@@ -8,10 +8,12 @@ import { Interaction } from '../Interaction';
 import type { AnswersQuestions } from '../questions';
 
 /**
- * Instructs the {@apilink Actor} to {@apilink CollectsArtifacts|collect} arbitrary static values and answers to {@apilink Answerable|Answerables},
- * so that they can be sent to the {@apilink StageCrewMember|StageCrewMembers}
- * and printed to the terminal by the {@apilink ConsoleReporter}
- * or attached to the HTML report by the {@apilink SerenityBDDReporter}.
+ * Instructs the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * to [collect](https://serenity-js.org/api/core/interface/CollectsArtifacts/) arbitrary static values
+ * and answers to [answerables](https://serenity-js.org/api/core/#Answerable),
+ * so that they can be sent to the [stage crew members](https://serenity-js.org/api/core/interface/StageCrewMember/)
+ * and printed to the terminal by the [`ConsoleReporter`](https://serenity-js.org/api/console-reporter/class/ConsoleReporter/)
+ * or attached to the HTML report by the [`SerenityBDDReporter`](https://serenity-js.org/api/serenity-bdd/class/SerenityBDDReporter/).
  *
  * ## Logging static and `Answerable` values
  *
@@ -29,7 +31,7 @@ import type { AnswersQuestions } from '../questions';
 export class Log extends Interaction {
 
     /**
-     * Instantiates a new {@apilink Interaction|interaction} to {@apilink Log}
+     * Instantiates a new [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Log`](https://serenity-js.org/api/core/class/Log/)
      *
      * Note that this method accepts [variable number of arguments](https://www.typescriptlang.org/docs/handbook/functions.html#rest-parameters),
      * so that you can easily log several values at the same time.

package/src/screenplay/notes/Notepad.ts

@@ -5,9 +5,9 @@ import { d } from '../../io';
 import { NotepadAdapter } from './NotepadAdapter';
 
 /**
- * Stores notes recorded by an {@apilink Actor}.
+ * Stores notes recorded by an [`Actor`](https://serenity-js.org/api/core/class/Actor/).
  *
- * See {@apilink TakeNotes} and [notes](/api/core/function/notes) for more usage examples.
+ * See [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/) and [notes](https://serenity-js.org/api/core/function/notes) for more usage examples.
  *
  * ## Sharing a notepad between actors
  *
@@ -47,9 +47,9 @@ import { NotepadAdapter } from './NotepadAdapter';
  *
  * ## Learn more
  *
- * - {@apilink TakeNotes}
- * - [notes](/api/core/function/notes)
- * - {@apilink Cast}
+ * - [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/)
+ * - [notes](https://serenity-js.org/api/core/function/notes)
+ * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
  *
  * @group Notes
  */
@@ -102,20 +102,20 @@ export class Notepad<Notes extends Record<any, any>> extends TinyType {
     }
 
     /**
-     * Creates a {@apilink QuestionAdapter} that simplifies access to the notes
-     * stored in this notepad. Allows the {@apilink Actor} to record, read, and remove notes.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that simplifies access to the notes
+     * stored in this notepad. Allows the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to record, read, and remove notes.
      *
      * #### Learn more
-     * - [notes](/api/core/function/notes)
-     * - {@apilink TakeNotes}
-     * - {@apilink Notepad}
+     * - [notes](https://serenity-js.org/api/core/function/notes)
+     * - [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/)
+     * - [`Notepad`](https://serenity-js.org/api/core/class/Notepad/)
      */
     static notes<N extends Record<any, any>>(): NotepadAdapter<N> {
         return new NotepadAdapter<N>();
     }
 
     /**
-     * Instantiates a {@apilink Notepad} with an initial state.
+     * Instantiates a [`Notepad`](https://serenity-js.org/api/core/class/Notepad/) with an initial state.
      *
      * @param recordedNotes
      *  Initial state of the notepad
@@ -146,8 +146,8 @@ export class Notepad<Notes extends Record<any, any>> extends TinyType {
      * @returns
      *  The value of the previously recorded note.
      *
-     * @throws {@apilink LogicError}
-     *  Throws a {@apilink LogicError} if the note with a given `subject`
+     * @throws [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
+     *  Throws a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/) if the note with a given `subject`
      *  has never been recorded.
      */
     get<Subject extends keyof Notes>(subject: Subject): Notes[Subject] {

package/src/screenplay/notes/NotepadAdapter.ts

@@ -12,10 +12,10 @@ import type { ChainableSetter } from './ChainableSetter';
 import { TakeNotes } from './TakeNotes';
 
 /**
- * Serenity/JS Screenplay Pattern-style adapter for the {@apilink Notepad},
- * that makes it easier for the {@apilink Actor|actors} to access its APIs.
+ * Serenity/JS Screenplay Pattern-style adapter for the [`Notepad`](https://serenity-js.org/api/core/class/Notepad/),
+ * that makes it easier for the [actors](https://serenity-js.org/api/core/class/Actor/) to access its APIs.
  *
- * See {@apilink TakeNotes}, {@apilink Notepad} and {@apilink notes} for more examples.
+ * See [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/), [`Notepad`](https://serenity-js.org/api/core/class/Notepad/) and [`notes`](https://serenity-js.org/api/core/function/notes/) for more examples.
  *
  * @group Notes
  */
@@ -25,7 +25,7 @@ export class NotepadAdapter<Notes extends Record<any, any>> implements Chainable
      * Checks if a note identified by `subject` exists in the notepad.
      *
      * #### Learn more
-     * - {@apilink Notepad.has}
+     * - [`Notepad.has`](https://serenity-js.org/api/core/class/Notepad/#has)}
      *
      * @param subject
      *   A subject (name) that uniquely identifies a given note
@@ -43,7 +43,7 @@ export class NotepadAdapter<Notes extends Record<any, any>> implements Chainable
      * Retrieves a note, identified by `subject`, from the notepad.
      *
      * #### Learn more
-     * - {@apilink Notepad.get}
+     * - [`Notepad.get`](https://serenity-js.org/api/core/class/Notepad/#get)}
      *
      * @param subject
      *   A subject (name) that uniquely identifies a given note
@@ -51,8 +51,8 @@ export class NotepadAdapter<Notes extends Record<any, any>> implements Chainable
      * @returns
      *  The value of the previously recorded note.
      *
-     * @throws {LogicError}
-     *  Throws a {@apilink LogicError} if the note with a given `subject`
+     * @throws
+     *  Throws a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/) if the note with a given `subject`
      *  has never been recorded.
      */
     get<Subject extends keyof Notes>(subject: Subject): QuestionAdapter<Notes[Subject]> {
@@ -66,9 +66,9 @@ export class NotepadAdapter<Notes extends Record<any, any>> implements Chainable
      * uniquely identified by its `subject`.
      *
      * **Pro tip:** calls to `set` can be chained and result in an accumulation
-     * of values to be recorded in the {@apilink Notepad}.
-     * Those values are resolved and recorded when the {@apilink Interaction}
-     * returned by this method is performed by an {@apilink Actor}.
+     * of values to be recorded in the [`Notepad`](https://serenity-js.org/api/core/class/Notepad/).
+     * Those values are resolved and recorded when the [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
+     * returned by this method is performed by an [`Actor`](https://serenity-js.org/api/core/class/Actor/).
      *
      * If a note identified by a given `subject` is set multiple times,
      * the last call wins.
@@ -99,7 +99,7 @@ export class NotepadAdapter<Notes extends Record<any, any>> implements Chainable
      * ```
      *
      * #### Learn more
-     * - {@apilink Notepad.set}
+     * - [`Notepad.set`](https://serenity-js.org/api/core/class/Notepad/#set)
      *
      * @param subject
      *   A subject (name) that uniquely identifies a given note
@@ -169,7 +169,7 @@ export class NotepadAdapter<Notes extends Record<any, any>> implements Chainable
      * ```
      *
      * #### Learn more
-     * - {@apilink Notepad.delete}
+     * - [`Notepad.delete`](https://serenity-js.org/api/core/class/Notepad/#delete)
      *
      * @param subject
      *
@@ -205,7 +205,7 @@ export class NotepadAdapter<Notes extends Record<any, any>> implements Chainable
      * ```
      *
      * #### Learn more
-     * - {@apilink Notepad.clear}
+     * - [`Notepad.clear`](https://serenity-js.org/api/core/class/Notepad/#clear)
      */
     clear(): Interaction {
         return Interaction.where(the`#actor clears ${ new NumberOfNotes() } from their notepad`, actor => {
@@ -234,7 +234,7 @@ export class NotepadAdapter<Notes extends Record<any, any>> implements Chainable
      * ```
      *
      * #### Learn more
-     * - {@apilink Notepad.size}
+     * - [`Notepad.size`](https://serenity-js.org/api/core/class/Notepad/#size)
      */
     size(): QuestionAdapter<number> {
         return Question.about(the`${ new NumberOfNotes() }`, async actor => {
@@ -243,12 +243,12 @@ export class NotepadAdapter<Notes extends Record<any, any>> implements Chainable
     }
 
     /**
-     * Produces a {@apilink QuestionAdapter} that resolves to a `JSONObject`
+     * Produces a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to a `JSONObject`
      * representing the resolved notes stored in the notepad.
      *
      * Note that serialisation to JSON will simplify some data types that might not be serialisable by default,
      * but are commonly used in data structures representing actor's notes.
-     * For example a {@apilink Map} will be serialised as a regular JSON object, a {@apilink Set} will be serialised as {@apilink Array}.
+     * For example a [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) will be serialised as a regular JSON object, a [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) will be serialised as [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array).
      *
      * Additionally, notepad assumes that the data structure you use it with does not contain cyclic references.
      *

package/src/screenplay/notes/TakeNotes.ts

@@ -2,21 +2,21 @@ import { Ability } from '../abilities';
 import { Notepad } from './Notepad';
 
 /**
- * An {@apilink Ability} that enables an {@apilink Actor} to remember information
+ * An [`Ability`](https://serenity-js.org/api/core/class/Ability/) that enables an [`Actor`](https://serenity-js.org/api/core/class/Actor/) to remember information
  * to be recalled during a test scenario.
  *
- * Under the hood, {@apilink TakeNotes} uses a {@apilink Notepad}, which state
+ * Under the hood, [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/) uses a [`Notepad`](https://serenity-js.org/api/core/class/Notepad/), which state
  * can be populated both during initialisation or while the test scenario is executed.
  * Populating the notepad when it's initialised can be useful to associate authentication credentials
  * or personal details with a given actor, while dynamic recording of notes during a test scenario
  * can be useful when the data to be recorded is not known upfront - for example when we want
  * the actor to remember a JWT stored in the browser and then use it when sending API requests.
  *
- * **Pro tip:** {@apilink TakeNotes}, {@apilink Notepad} and {@apilink notes} can be typed
+ * **Pro tip:** [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/), [`Notepad`](https://serenity-js.org/api/core/class/Notepad/) and [`notes`](https://serenity-js.org/api/core/function/notes/) can be typed
  * using [TypeScript generics](https://www.typescriptlang.org/docs/handbook/2/generics.html)
  * to help you avoid typos when specifying note names.
  *
- * See [notes](/api/core/function/notes) and {@apilink Notepad} for more usage examples.
+ * See [notes](https://serenity-js.org/api/core/function/notes) and [`Notepad`](https://serenity-js.org/api/core/class/Notepad/) for more usage examples.
  *
  * ## Remembering and retrieving a value
  *
@@ -224,23 +224,23 @@ import { Notepad } from './Notepad';
  *
  * ## Learn more
  *
- * - [notes](/api/core/function/notes)
- * - {@apilink Notepad}
+ * - [notes](https://serenity-js.org/api/core/function/notes)
+ * - [`Notepad`](https://serenity-js.org/api/core/class/Notepad/)
  *
  * @group Notes
  */
 export class TakeNotes<Notes_Type extends Record<any, any>> extends Ability {
 
     /**
-     * Initialises an {@apilink Ability} to {@apilink TakeNotes} with {@apilink Notepad.empty}.
+     * Initialises an [`Ability`](https://serenity-js.org/api/core/class/Ability/) to [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/) with [`Notepad.empty`](https://serenity-js.org/api/core/class/Notepad/#empty).
      */
     static usingAnEmptyNotepad<N extends Record<any, any>>(): TakeNotes<N> {
         return TakeNotes.using<N>(Notepad.empty<N>());
     }
 
     /**
-     * Initialises an {@apilink Ability} to {@apilink TakeNotes} using
-     * a {@apilink Notepad.with} some initial state.
+     * Initialises an [`Ability`](https://serenity-js.org/api/core/class/Ability/) to [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes/) using
+     * a [`Notepad.with`](https://serenity-js.org/api/core/class/Notepad/#with) some initial state.
      *
      * @param notepad
      */

package/src/screenplay/notes/notes.ts

@@ -2,10 +2,10 @@ import { Notepad } from './Notepad';
 import type { NotepadAdapter } from './NotepadAdapter';
 
 /**
- * Alias for {@apilink Notepad.notes}.
+ * Alias for [`Notepad.notes`](https://serenity-js.org/api/core/class/Notepad/#notes).
  *
- * **Pro tip:** `notes<T>().get(subject)` returns a {@apilink NotepadAdapter} to make accessing the APIs
- * of the underlying type easier. Check {@apilink NotepadAdapter} for more examples.
+ * **Pro tip:** `notes<T>().get(subject)` returns a [`NotepadAdapter`](https://serenity-js.org/api/core/class/NotepadAdapter/) to make accessing the APIs
+ * of the underlying type easier. Check [`NotepadAdapter`](https://serenity-js.org/api/core/class/NotepadAdapter/) for more examples.
  *
  * ## Working with untyped notes
  *
@@ -109,9 +109,9 @@ import type { NotepadAdapter } from './NotepadAdapter';
  *
  * ## Learn more
  *
- * - {@apilink NotepadAdapter}
- * - {@apilink Notepad.notes}
- * - {@apilink QuestionAdapter}
+ * - [`NotepadAdapter`](https://serenity-js.org/api/core/class/NotepadAdapter/)
+ * - [`Notepad.notes`](https://serenity-js.org/api/core/class/Notepad/#notes)
+ * - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
  *
  * @group Notes
  */

package/src/screenplay/questions/AnswersQuestions.ts

@@ -1,19 +1,19 @@
 import type { Answerable } from '../Answerable';
 
 /**
- * Describes an {@apilink Actor} who can answer a {@apilink Question} about the system under test.
+ * Describes an [`Actor`](https://serenity-js.org/api/core/class/Actor/) who can answer a [`Question`](https://serenity-js.org/api/core/class/Question/) about the system under test.
  *
  * ## Learn more
  *
- * - {@apilink Question}
- * - {@apilink Actor}
+ * - [`Question`](https://serenity-js.org/api/core/class/Question/)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
  *
  * @group Actors
  */
 export interface AnswersQuestions {
 
     /**
-     * Makes the {@apilink Actor} evaluate an {@apilink Answerable}
+     * Makes the [`Actor`](https://serenity-js.org/api/core/class/Actor/) evaluate an [`Answerable`](https://serenity-js.org/api/core/#Answerable)
      * and return the value it holds.
      */
     answer<T>(answerable: Answerable<T>): Promise<T>;

package/src/screenplay/questions/ChainableMetaQuestion.ts

@@ -3,14 +3,14 @@ import type { Question } from '../Question';
 import type { MetaQuestion } from './MetaQuestion';
 
 /**
- * A chainable meta-question is a {@apilink MetaQuestion} that can be answered
- * in the context of another {@apilink Answerable},
+ * A chainable meta-question is a [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/) that can be answered
+ * in the context of another [`Answerable`](https://serenity-js.org/api/core/#Answerable),
  * and form a chain of transformations.
  *
- * {@apilink MetaQuestion|Meta questions} are typically used when filtering a {@apilink List}.
+ * [Meta-questions](https://serenity-js.org/api/core/interface/MetaQuestion/) are typically used when filtering a [`List`](https://serenity-js.org/api/core/class/List/).
  *
  * ## Learn more
- * - {@apilink List}
+ * - [`List`](https://serenity-js.org/api/core/class/List/)
  *
  * @group Questions
  */
@@ -20,11 +20,11 @@ export interface ChainableMetaQuestion<
 > extends MetaQuestion<Supported_Context_Type, Returned_Question_Type & ChainableMetaQuestion<Supported_Context_Type, Returned_Question_Type>> {
 
     /**
-     * Answers the given `ChainableMetaQuestion` in the context of another {@apilink Answerable}
+     * Answers the given `ChainableMetaQuestion` in the context of another [`Answerable`](https://serenity-js.org/api/core/#Answerable)
      * and returns another `ChainableMetaQuestion` ready for further chaining.
      *
      * #### Learn more
-     * - {@apilink List}
+     * - [`List`](https://serenity-js.org/api/core/class/List/)
      */
     of(context: Answerable<Supported_Context_Type>): Returned_Question_Type & ChainableMetaQuestion<Supported_Context_Type, Returned_Question_Type>;
 }

package/src/screenplay/questions/Check.ts

@@ -9,7 +9,7 @@ import { ExpectationMet } from './expectations';
 
 /**
  * A [flow control statement](https://en.wikipedia.org/wiki/Control_flow)
- * that enables an {@apilink Actor} to decide between two alternate series of {@apilink Activity|activities}.
+ * that enables an [`Actor`](https://serenity-js.org/api/core/class/Actor/) to decide between two alternate series of [activities](https://serenity-js.org/api/core/class/Activity/).
  *
  * Think of it as a Screenplay Pattern equivalent of the traditional `if` statement.
  *
@@ -66,7 +66,7 @@ export class Check<Actual> extends Task {
 
     /**
      * @param alternativeActivities
-     *  A sequence of {@apilink Activity|activities} to perform when the {@apilink Expectation} is not met.
+     *  A sequence of [activities](https://serenity-js.org/api/core/class/Activity/) to perform when the [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) is not met.
      */
     otherwise(...alternativeActivities: Activity[]): Task {
         return new Check<Actual>(this.actual, this.expectation, this.activities, alternativeActivities);

package/src/screenplay/questions/DescriptionFormattingOptions.ts

@@ -1,6 +1,6 @@
 /**
- * Configuration options for {@apilink Question.formattedValue} and
- * the [`the`](/api/core/function/the/) function.
+ * Configuration options for [`Question.formattedValue`](https://serenity-js.org/api/core/class/Question/#formattedValue) and
+ * the [`the`](https://serenity-js.org/api/core/function/the/) function.
  *
  * @group Questions
  */

package/src/screenplay/questions/Expectation.ts

@@ -17,15 +17,18 @@ export type Predicate<Actual> = (actor: AnswersQuestions, actual: Answerable<Act
 type AnswerableArguments<Arguments extends Array<unknown>> = { [Index in keyof Arguments]: Answerable<Arguments[Index]> };
 
 /**
- * Defines an expectation to be used with {@apilink @apilink Wait.until}, {@apilink Check.whether}, {@apilink Ensure.that}
- * and as part of the Page Element Query Language with {@apilink PageElements.where} and {@apilink List.where}.
+ * Defines an expectation to be used with [`Wait.until`](https://serenity-js.org/api/core/class/Wait/#until),
+ * [`Check.whether`](https://serenity-js.org/api/core/class/Check/#whether),
+ * [`Ensure.that`](https://serenity-js.org/api/assertions/class/Ensure/#that)
+ * and as part of the Page Element Query Language with [`PageElements.where`](https://serenity-js.org/api/web/class/PageElements/#where)
+ * and [`List.where`](https://serenity-js.org/api/core/class/List/#where).
  *
  * @group Expectations
  */
 export class Expectation<Actual> extends Describable {
 
     /**
-     * A factory method to that makes defining custom {@apilink Expectation|expectations} easier
+     * A factory method to that makes defining custom [expectations](https://serenity-js.org/api/core/class/Expectation/) easier
      *
      * #### Defining a custom expectation
      *
@@ -96,16 +99,16 @@ export class Expectation<Actual> extends Describable {
      * ```
      *
      * #### Learn more
-     * - {@apilink Ensure}
-     * - {@apilink Check}
-     * - {@apilink Wait}
+     * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
+     * - [`Check`](https://serenity-js.org/api/core/class/Check/)
+     * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
      *
      * @param functionName
-     *  Name of the expectation function to be used when producing an {@apilink AssertionError}
+     *  Name of the expectation function to be used when producing an [`AssertionError`](https://serenity-js.org/api/core/class/AssertionError/)
      *
      * @param relationship
      *  Human-readable description of the relationship between the `expected` and the `actual` values.
-     *  Used when reporting {@apilink Activity|activities} performed by an {@apilink Actor|actor}
+     *  Used when reporting [activities](https://serenity-js.org/api/core/class/Activity/) performed by an [actor](https://serenity-js.org/api/core/class/Actor/)
      *
      * @param predicate
      */
@@ -149,7 +152,7 @@ export class Expectation<Actual> extends Describable {
     }
 
     /**
-     * Used to define a simple {@apilink Expectation}
+     * Used to define a simple [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
      *
      * #### Simple parameterised expectation
      *
@@ -201,9 +204,9 @@ export class Expectation<Actual> extends Describable {
     }
 
     /**
-     * Used to compose {@apilink Expectation|expectations}.
+     * Used to compose [expectations](https://serenity-js.org/api/core/class/Expectation/).
      *
-     * #### Composing {@apilink Expectation|expectations}
+     * #### Composing [expectations](https://serenity-js.org/api/core/class/Expectation/)
      *
      * ```ts
      * import { actorCalled, Expectation } from '@serenity-js/core'
@@ -255,9 +258,9 @@ export class Expectation<Actual> extends Describable {
     }
 
     /**
-     * Returns a {@apilink QuestionAdapter} that resolves to {@apilink ExpectationOutcome}
-     * indicating that the {@apilink ExpectationMet|expectation was met}
-     * or that the {@apilink ExpectationNotMet|expectation was not met}
+     * Returns a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ExpectationOutcome`](https://serenity-js.org/api/core/class/ExpectationOutcome/)
+     * indicating that the [expectation was met](https://serenity-js.org/api/core/class/ExpectationMet/)
+     * or that the [expectation was not met](https://serenity-js.org/api/core/class/ExpectationNotMet/)
      *
      * @param actual
      */

package/src/screenplay/questions/List.ts

@@ -11,8 +11,8 @@ import type { Expectation } from './Expectation';
 import { ExpectationMet } from './expectations';
 
 /**
- * Serenity/JS Screenplay Pattern-style wrapper around {@apilink Array}
- * and array-like structures - see {@apilink PageElements}.
+ * Serenity/JS Screenplay Pattern-style wrapper around [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
+ * and array-like structures - see [`PageElement`](https://serenity-js.org/api/web/class/PageElements/).
  *
  * @group Questions
  */
@@ -153,10 +153,10 @@ class ArrayList<Item_Type> extends List<Item_Type> {
 
 /**
  * Serenity/JS Screenplay Pattern-style wrapper around
- * a {@apilink ChainableMetaQuestion} representing a collection
- * that can be resolved in `Supported_Context_Type` of another {@apilink Question}.
+ * a [`ChainableMetaQuestion`](https://serenity-js.org/api/core/interface/ChainableMetaQuestion/) representing a collection
+ * that can be resolved in `Supported_Context_Type` of another [`Question`](https://serenity-js.org/api/core/class/Question/).
  *
- * For example, {@apilink PageElements.located} returns `MetaList<PageElement>`,
+ * For example, [`PageElements.located`](https://serenity-js.org/api/web/class/PageElements/#located) returns `MetaList<PageElement>`,
  * which allows for the collection of page elements to be resolved in the context
  * of dynamically-provided root element.
  *

package/src/screenplay/questions/Masked.ts

@@ -29,8 +29,10 @@ export class Masked {
      *   );
      * ```
      *
-     * @param parameter - An {@link Answerable} representing the masked value.
-     * @returns A {@link QuestionAdapter} representing the masked value.
+     * @param parameter
+     *  An [`Answerable`](https://serenity-js.org/api/core/#Answerable) representing the masked value.
+     * @returns
+     *  A [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) representing the masked value.
      */
     static valueOf(parameter: Answerable<string>): QuestionAdapter<string> {
         return Question.about('[a masked value]', async actor => actor.answer(parameter));

package/src/screenplay/questions/MetaQuestion.ts

@@ -2,32 +2,32 @@ import type { Answerable } from '../Answerable';
 import type { Question } from '../Question';
 
 /**
- * A meta-question is a {@apilink Question} that can be answered
- * in the context of another {@apilink Answerable},
+ * A meta-question is a [`Question`](https://serenity-js.org/api/core/class/Question/) that can be answered
+ * in the context of another [`Answerable`](https://serenity-js.org/api/core/#Answerable),
  * typically to transform its value.
  *
- * For example, the question {@apilink Text.of} can be answered in the context
- * of a {@apilink PageElement} to return its text content.
+ * For example, the question [`Text.of`](https://serenity-js.org/api/web/class/Text/#of) can be answered in the context
+ * of a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) to return its text content.
  *
- * {@apilink MetaQuestion|Meta questions} are typically used when filtering a {@apilink List}.
+ * [Meta-questions](https://serenity-js.org/api/core/interface/MetaQuestion/) are typically used when filtering a [`List`](https://serenity-js.org/api/core/class/List/).
  *
  * ## Learn more
- * - {@apilink List}
+ * - [`List`](https://serenity-js.org/api/core/class/List/)
  *
  * @group Questions
  */
 export interface MetaQuestion<Supported_Context_Type, Returned_Question_Type extends Question<unknown>> {
 
     /**
-     * Answers the given `MetaQuestion` in the context of another {@apilink Answerable}.
+     * Answers the given `MetaQuestion` in the context of another [`Answerable`](https://serenity-js.org/api/core/#Answerable).
      *
      * #### Learn more
-     * - {@apilink List}
+     * - [`List`](https://serenity-js.org/api/core/class/List/)
      */
     of(context: Answerable<Supported_Context_Type>): Returned_Question_Type;
 
     /**
-     * Human-readable description of this {@apilink MetaQuestion},
+     * Human-readable description of this [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/),
      * typically involving the description of the subject.
      *
      * For example, a description of a meta question obout "the text of an element"

package/src/screenplay/questions/Unanswered.ts

@@ -3,8 +3,8 @@ import { TinyType } from 'tiny-types';
 import * as util from 'util';   // eslint-disable-line unicorn/import-style
 
 /**
- * A placeholder value signifying that a {@apilink Question}
- * has not been answered by an {@apilink Actor} when producing an {@apilink ExpectationOutcome}.
+ * A placeholder value signifying that a [`Question`](https://serenity-js.org/api/core/class/Question/)
+ * has not been answered by an [`Actor`](https://serenity-js.org/api/core/class/Actor/) when producing an [`ExpectationOutcome`](https://serenity-js.org/api/core/class/ExpectationOutcome/).
  * This happens when Serenity/JS decides that answering a given question
  * won't affect the outcome.
  *

package/src/screenplay/questions/expectations/ExpectationDetails.ts

@@ -6,7 +6,7 @@ import { Name } from '../../../model';
 import { Unanswered } from '../Unanswered';
 
 /**
- * Used with {@apilink ExpectationOutcome} to describe an {@apilink Expectation} and the arguments it's been executed with.
+ * Used with [`ExpectationOutcome`](https://serenity-js.org/api/core/class/ExpectationOutcome/) to describe an [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) and the arguments it's been executed with.
  *
  * @group Expectations
  */

package/src/screenplay/questions/expectations/ExpectationMet.ts

@@ -1,7 +1,7 @@
 import { ExpectationOutcome } from './ExpectationOutcome';
 
 /**
- * Indicates that an {@apilink Expectation} was met.
+ * Indicates that an [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) was met.
  *
  * @group Expectations
  */

package/src/screenplay/questions/expectations/ExpectationNotMet.ts

@@ -1,7 +1,7 @@
 import { ExpectationOutcome } from './ExpectationOutcome';
 
 /**
- * Indicates that an {@apilink Expectation} was not met.
+ * Indicates that an [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) was not met.
  *
  * @group Expectations
  */

package/src/screenplay/questions/expectations/ExpectationOutcome.ts

@@ -3,8 +3,8 @@ import { TinyType } from 'tiny-types';
 import type { ExpectationDetails } from './ExpectationDetails';
 
 /**
- * An outcome of an {@apilink Expectation},
- * which could be either {@apilink ExpectationMet|met} or {@apilink ExpectationNotMet|not met}.
+ * An outcome of an [`Expectation`](https://serenity-js.org/api/core/class/Expectation/),
+ * which could be either [met](https://serenity-js.org/api/core/class/ExpectationMet/) or [not met](https://serenity-js.org/api/core/class/ExpectationNotMet/).
  *
  * @group Expectations
  */