yera.apps.builtin.guide.app

Define Yera's documentation-grounded built-in guide.

Symbols

def guide — Answer questions about Yera from its documentation.
def overview — Return the installed conceptual overview and public API summary.
def respond — Answer one user message, reading documentation when required.
def start_session — Insert the installed overview into a new guide conversation.

guide

guide() → None

Answer questions about Yera from its documentation.

overview

overview() → str

Return the installed conceptual overview and public API summary.

Returns

type: str

Versioned overview text followed by the installed public API list.

respond

respond(
    session: _DocsSession,
    prompt: str,
    trace: list[str] | None = None,
) → str

Answer one user message, reading documentation when required.

Parameters

session
type: _DocsSession

Documentation state retained for this conversation.

prompt
type: str

User message to answer.

trace
type: list[str] | None = None

Optional destination for routing and retrieval diagnostics.

Returns

type: str

Generated answer, or the documentation-unavailable message.

start_session

start_session() → None

Insert the installed overview into a new guide conversation.