framework/dist/dashboard/docs.d.ts

The (AI) Framework: turnkey, zero-config AI orchestration that wraps a coding-agent CLI (Claude Code) as a black box and takes you from an idea to a running app. Vite for AI.

/**
 * The plan/backlog document categories the dashboard surfaces in its sidebar
 * (#319, part of the MVP UI #309), so the human can read them beside the agent.
 *
 * The Framework's system prompt writes these per session (#323/#326):
 * `PLAN_<SESSION>.agent.md` (the plan for now) and `TODO_<SESSION>.agent.md` (the
 * backlog), where SESSION is a git-branch slug. The flat fallbacks are `PLAN.md`
 * (root) and the flat backlog (`backlog: true` reads `TODO_AGENTS.md` off the data
 * branch, its one location since #1582). Scoped and flat-root names are matched
 * against a flat readdir of the root, never taken from user input, so there is no
 * path traversal to guard against.
 */
export declare const DOC_CATEGORIES: readonly [{
    readonly flat: "PLAN.md";
    readonly scoped: RegExp;
}, {
    readonly flat: "TODO_AGENTS.md";
    readonly backlog: true;
    readonly scoped: RegExp;
}];
/** One surfaced document: its filename and current contents. */
export interface WorkspaceDoc {
    name: string;
    content: string;
}
/**
 * The workspace-root filenames to surface, in sidebar order: per category the flat
 * file (if present) then its session-scoped files (sorted). Every name is a bare
 * readdir entry matched against a fixed pattern, so none can traverse. Returns
 * empty when the workspace is missing or unreadable.
 */
/**
 * Read the surfaced plan/backlog docs, in sidebar order: per category the flat file (if present)
 * then its session-scoped files (sorted). The flat backlog comes off the data branch (#1582);
 * everything else is a workspace-root file. Missing or blank files are skipped; a file over the
 * size cap is truncated. Never throws — a read error just omits that doc.
 */
export declare function readDocs(cwd: string): Promise<WorkspaceDoc[]>;
//# sourceMappingURL=docs.d.ts.map