Skip to content

Conversation

@91volt
Copy link

@91volt 91volt commented Nov 25, 2025

Summary

This PR enhances the documentation for the Cloud LLM Brick to provide better guidance for users and clearer API definitions.

What changed

  • Markdown Documentation:
    • Rewrote the Overview and Features sections for better clarity.
    • Added detailed Configuration and Supported Models tables.
    • Added instructions on how to setup LLM api key.
    • Improved code examples for basic chat and streaming with memory.
    • Added a summary of available Methods.
  • Python Code:
    • Updated class and method docstrings to include precise argument types, return values, and raised exceptions.
    • Added docstrings for internal helpers like model_factory.

@91volt 91volt marked this pull request as ready for review November 25, 2025 14:58
@91volt 91volt changed the title [PXCT-1315] Update Cloud LLM brick docs Update Cloud LLM brick docs Nov 25, 2025
Copy link

@mcmchris mcmchris left a comment

Choose a reason for hiding this comment

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

LGTM!

@91volt 91volt marked this pull request as draft November 26, 2025 11:33
@91volt 91volt marked this pull request as ready for review November 26, 2025 12:05
@stefanotorneo stefanotorneo merged commit f1d346d into arduino:release-1.0 Nov 26, 2025
2 checks passed
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.

3 participants