Interface: DocumentationService

Defined in: domain/contracts.ts:659

Context-aware help and documentation lookup.

Methods

getDocumentation()

getDocumentation(query): Promise<DocumentationEntry | null>;

Defined in: domain/contracts.ts:664

Get documentation for a specific context (profile, field, type, app topic) Returns label, description, or full article based on requested level

Parameters

Parameter	Type
query	DocumentationQuery

Returns

Promise<DocumentationEntry | null>

---

listTopics()

listTopics(input): Promise<DocumentationEntry[]>;

Defined in: domain/contracts.ts:678

Get all available help topics for a context (e.g., all fields in a profile)

Parameters

Parameter	Type
input	{ context: "workspace" | "profile" | "field" | "type" | "app"; locale?: string; parentId?: string; }
input.context	"workspace" | "profile" | "field" | "type" | "app"
input.locale?	string
input.parentId?	string

Returns

Promise<DocumentationEntry[]>

---

registerAppHelp()

registerAppHelp(input): Promise<void>;

Defined in: domain/contracts.ts:687

Register custom app-level help articles

Parameters

Parameter	Type
input	{ entry: DocumentationEntry; }
input.entry	DocumentationEntry

Returns

Promise<void>

---

searchDocumentation()

searchDocumentation(input): Promise<DocumentationEntry[]>;

Defined in: domain/contracts.ts:669

Search documentation entries by keyword

Parameters

Parameter	Type
input	{ context?: "workspace" | "profile" | "field" | "type" | "app"; locale?: string; query: string; }
input.context?	"workspace" | "profile" | "field" | "type" | "app"
input.locale?	string
input.query	string

Returns

Promise<DocumentationEntry[]>