Skip to content

Conversation

hghalebi
Copy link
Contributor

@hghalebi hghalebi commented Oct 2, 2025

1. Architecture Documentation (mod.rs)

Added:

  • ASCII diagram showing abstraction layers
  • Clear explanation of Prompt, Chat, and Completion traits
  • "When to use" guidance for each abstraction level
  • Provider-agnostic design examples

Impact: Developers now understand the system architecture at a glance.

2. Common Patterns Section (All Files)

Added to mod.rs:

  • Error handling with retry logic
  • Streaming responses
  • Building conversation history
  • Exponential backoff examples

Added to message.rs:

  • Building conversation history
  • Multimodal messages (text + images)
  • Working with tool results
  • Performance tips

Impact: Real-world usage patterns are now documented.

3. Troubleshooting Guide (message.rs)

Added:

  • "Media type required" error solutions
  • Provider capability table
  • Large image handling tips
  • Builder pattern common mistakes
  • Compile_fail examples showing wrong approaches

Copy link
Contributor

@joshua-mo-143 joshua-mo-143 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes to be made:

  • Please move all .md files to a folder in the top level of the project (maybe something like "prompts"?).
  • Delete whatever .md files you don't actually need for feeding into a prompt.

Rest looks OK... I think. We might need to move some of it into the docsite, there is a lot here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants