Skip to content
CtrlK

DocumentationVersion

On this page
import type { DocumentationVersion } from "ardo/config"

type DocumentationVersion = {
    /** Stable version id, usually the major line such as "v3" or "v2". */
    id: string;
    /** Human-readable label shown in the version switcher. Defaults to id. */
    label?: string;
    /** Public path for this major documentation version, such as "/v3/". */
    path: string;
};

Properties

NameTypeRequiredDescription
idstringYesStable version id, usually the major line such as "v3" or "v2".
labelstringNoHuman-readable label shown in the version switcher. Defaults to id.
pathstringYesPublic path for this major documentation version, such as "/v3/".