Skip to content

Add structured metadata to code examples (extras, return type, min version) #841

@abrahamdaniels

Description

@abrahamdaniels

Code blocks on docs.mellea.ai do not indicate which mellea extras are required to run them, what the return type of the primary call is, or what minimum version they target. An agent or user copying a code block that requires mellea[litellm] but only has base mellea installed gets a silent import error with no doc-side indication of the cause.

Fix: Use Mintlify's code block annotation syntax to add metadata to all non-trivial examples

"Vertex AI example" description="Requires mellea[litellm]. Returns ModelOutputThunk."

At minimum, annotate all integration examples (each backend page) and any example using a non-default return type (SamplingResult, Pydantic model, etc.).

Location: All integration pages, IVR tutorial, structured output how-to

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions