Interface DocumentationCollection

One rendered document collection inside the TypeDoc site.

interface DocumentationCollection {
    id: string;
    label: string;
    source: string;
    purpose: string;
}

Properties

id: string

Stable collection id used in navigation and deployment notes.

label: string

Human-readable label shown to operators and contributors.

source: string

Repo path or glob that feeds the collection.

purpose: string

Why this collection matters in the active runtime.