Skip to content

docs: document conversation and memory APIs #96

@ZackBradshaw

Description

@ZackBradshaw

Summary

structs::conversation exposes AgentConversation, AgentShortMemory, and SwarmConversation, but README/docs do not explain usage, limits, import/export formats, or role/content structures.

Why this matters

Users can discover these APIs in code but cannot reliably use them without reading source.

Scope

  • Add a dedicated docs page for conversation APIs
  • Document message lifecycle (add, update, delete, search, clear)
  • Document persistence hooks (export_to_file, import_from_file, JSON behavior)
  • Link examples from main README

Acceptance criteria

  • New docs page exists with runnable examples
  • README links to the page
  • Edge cases and limitations are noted

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions