@promptbook/google/esm/src/book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown.d.ts

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

import type { string_book } from '../agent-source/string_book';
import type { string_markdown } from '../../types/string_markdown';
import type { string_language } from '../../types/string_token';
/**
 * Agent source incorporated into a server-specific Book language manual.
 *
 * @public exported from `@promptbook/core`
 */
export type BookLanguageDocumentationAgent = {
    /**
     * Human-readable title shown above the baked example.
     */
    readonly agentName: string;
    /**
     * Current Book source used both as an example and to detect used commitments.
     */
    readonly agentSource: string_book;
};
/**
 * Optional context used to tailor a standalone Book language manual.
 *
 * An empty `agents` array deliberately has the same effect as omitting this
 * option, which keeps the non-customized manual portable between servers.
 *
 * @public exported from `@promptbook/core`
 */
export type CreateStandaloneBookLanguageMarkdownOptions = {
    /**
     * Server agents whose sources should be baked into examples and usage priority.
     */
    readonly agents?: ReadonlyArray<BookLanguageDocumentationAgent>;
    /**
     * Language the manual should be written in, English is used as the fallback.
     */
    readonly language?: string_language;
    /**
     * Whether the closing chapter with low-level commitments should be generated.
     *
     * Low-level commitments are intended for advanced use only, so they are
     * omitted unless they are explicitly requested.
     */
    readonly isLowLevelCommitmentsIncluded?: boolean;
};
/**
 * Creates one standalone markdown guide for Book language (Book 2.0 / agent language).
 *
 * The output intentionally combines:
 * - static conceptual building blocks maintained in this repository
 * - dynamically generated commitment catalog from runtime commitment definitions
 * so docs stay up-to-date by design.
 *
 * @returns Full standalone markdown document.
 *
 * @public exported from `@promptbook/core`
 */
export declare function createStandaloneBookLanguageMarkdown(options?: CreateStandaloneBookLanguageMarkdownOptions): string_markdown;