@promptbook/remote-client/umd/src/book-2.0/book-language-documentation/BookLanguageDocumentationExample.d.ts

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

/**
 * One end-to-end Book language example used in standalone documentation.
 *
 * @private internal utility of `createStandaloneBookLanguageMarkdown`
 */
export type BookLanguageDocumentationExample = {
    /**
     * Stable identifier used for markdown anchors.
     */
    readonly id: string;
    /**
     * Human-readable example title.
     */
    readonly title: string;
    /**
     * Goal of the example in one short sentence.
     */
    readonly goal: string;
    /**
     * Full Book source shown to readers.
     */
    readonly source: string;
    /**
     * Step-by-step walkthrough of how the source works.
     */
    readonly walkthrough: ReadonlyArray<string>;
};