@promptbook/remote-client/esm/src/book-2.0/book-language-documentation/renderGroupedCommitmentDocumentationMarkdown.d.ts

Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action

/**
 * Minimal commitment shape used by documentation renderers.
 *
 * @private internal utility of `createStandaloneBookLanguageMarkdown`
 */
type CommitmentDocumentationSource = {
    /**
     * Canonical commitment keyword.
     */
    readonly type: string;
    /**
     * Full markdown documentation block, including the top-level heading.
     */
    readonly documentation: string;
};
/**
 * Grouped commitment metadata consumed by the docs renderer.
 *
 * @private internal utility of `createStandaloneBookLanguageMarkdown`
 */
type GroupedCommitmentDocumentationSource = {
    /**
     * Primary commitment shown in the docs entry.
     */
    readonly primary: CommitmentDocumentationSource;
    /**
     * Aliases grouped under the same docs entry.
     */
    readonly aliases: ReadonlyArray<string>;
};
/**
 * Renders the documentation body for one grouped commitment entry.
 *
 * `OPEN` and `CLOSED` are intentionally rendered together so the documentation
 * surfaces present them as one conceptual switch instead of two isolated pages.
 *
 * @param group - Grouped commitment metadata.
 * @returns Markdown body for the docs page/catalog entry.
 *
 * @private internal utility of `createStandaloneBookLanguageMarkdown`
 */
export declare function renderGroupedCommitmentDocumentationMarkdown(group: GroupedCommitmentDocumentationSource): string;
export {};