Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhancement]: Improve Prompt Management Documentation #2247

Conversation

aybruhm
Copy link
Member

@aybruhm aybruhm commented Nov 12, 2024

Description

This PR updates and improves the prompt management documentation to reflect recent changes in the Prompt SDK and backend. It includes updated examples, and additional guidance for using synchronous and asynchronous methods.

Related Issue

Closes AGE-1284

Additional Improvement

  • Add Prompt model in SDK types
  • Update async method naming in ConfigManager for consistency across manager method
  • Update test_config_manager SDK tests to make use of updated method naming

Copy link

vercel bot commented Nov 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
agenta ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 0:20am
agenta-documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 0:20am

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Nov 12, 2024
@aybruhm aybruhm requested a review from mmabrouk November 12, 2024 08:35
@dosubot dosubot bot added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 12, 2024
…ariantManager and DeploymentManager method(s)
Copy link
Member

@mmabrouk mmabrouk left a comment

Choose a reason for hiding this comment

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

Thanks @aybruhm ! I've added minor comment. I think the main thing is that the PR is not clean

agenta-cli/agenta/sdk/types.py Outdated Show resolved Hide resolved
docs/docs/prompt-management/03-prompt-management-sdk.mdx Outdated Show resolved Hide resolved
@aybruhm aybruhm requested a review from mmabrouk November 12, 2024 10:23
@aybruhm
Copy link
Member Author

aybruhm commented Nov 12, 2024

OSS is inaccessible, thus the reason why the workflow is failing.

Copy link
Member

@mmabrouk mmabrouk left a comment

Choose a reason for hiding this comment

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

Thanks @aybruhm !

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Nov 12, 2024
@mmabrouk mmabrouk merged commit 0297b0b into mmabrouk/docs/AGE-1151-prompt-management-documentation Nov 12, 2024
6 of 7 checks passed
@mmabrouk mmabrouk deleted the cleanup/prompt-management-doc branch November 12, 2024 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants