@promptbook/remote-server/umd/src/book-2.0/book-language-documentation/bookLanguageCommonPitfalls.d.ts

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

/**
 * One practical "don't vs do" pitfall item for Book language authoring.
 *
 * @private internal utility of `createStandaloneBookLanguageMarkdown`
 */
export type BookLanguageCommonPitfall = {
    /**
     * Short pitfall title.
     */
    readonly title: string;
    /**
     * Description of what to avoid.
     */
    readonly dont: string;
    /**
     * Practical corrective action.
     */
    readonly doInstead: string;
};
/**
 * Common anti-patterns with practical fixes.
 *
 * @private internal utility of `createStandaloneBookLanguageMarkdown`
 */
export declare const bookLanguageCommonPitfalls: ReadonlyArray<BookLanguageCommonPitfall>;