MentorAgent Docs
Menu

ReferencePackage: Novior.MentorAgent.Abstractions

MentorTourStep record

The MentorTourStep record of Novior.MentorAgent.Abstractions.Models: One step of the AI-guided onboarding tour (roadmap #18).

View as Markdown
On this page

One step of the AI-guided onboarding tour (roadmap #18).

Namespace: Novior.MentorAgent.Abstractions.Models. Package: Novior.MentorAgent.Abstractions.

public sealed record MentorTourStep : IEquatable<MentorTourStep>

Terminal
dotnet add package Novior.MentorAgent.Abstractions

public MentorTourStep(string Title, string Body, string? Url = null, string? TryAsking = null)

One step of the AI-guided onboarding tour (roadmap #18).

Parameters

  • Title: Short heading, a few words.
  • Body: One or two sentences explaining what this part of the app is for.
  • Url: Page the step is about, when there is one. The tour offers to navigate there; a step with no URL is a general one (welcome, closing).
  • TryAsking: A ready-made question the user can send to the assistant from this step. This is what makes the tour worth generating rather than writing by hand: the hardest part of adopting an in-app assistant is not knowing what it can be asked, and an example drawn from the app's own tools answers that better than any generic hint.

public string Body { get; init; }

One or two sentences explaining what this part of the app is for.

public string Title { get; init; }

Short heading, a few words.

public string? TryAsking { get; init; }

A ready-made question the user can send to the assistant from this step. This is what makes the tour worth generating rather than writing by hand: the hardest part of adopting an in-app assistant is not knowing what it can be asked, and an example drawn from the app's own tools answers that better than any generic hint.

public string? Url { get; init; }

Page the step is about, when there is one. The tour offers to navigate there; a step with no URL is a general one (welcome, closing).