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

Update readme callout #95

Merged
merged 19 commits into from
Sep 30, 2024
Merged

Update readme callout #95

merged 19 commits into from
Sep 30, 2024

Conversation

paul-paliychuk
Copy link
Contributor

@paul-paliychuk paul-paliychuk commented Sep 29, 2024

Important

Update README.md to clarify installation instructions and add callouts for different SDK versions.

  • Installation Instructions:
    • Renamed "Installation Notes" to "Cloud Installation".
    • Added "Community Installation" section for community SDK.
    • Added "Zep v0.x Compatible SDK" section for legacy SDK.
  • Callouts:
    • Added callouts with links to documentation for each SDK version in README.md.

This description was created by Ellipsis for e9ba590. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 1b91a96 in 4 seconds

More details
  • Looked at 36 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. README.md:27
  • Draft comment:
    Grammatical error. Consider rephrasing to:
You can install the cloud SDK by running:
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The phrase 'You can install cloud sdk it by running:' is grammatically incorrect. It should be 'You can install the cloud SDK by running:'.

Workflow ID: wflow_QZrSL2aH2O2iQaPH


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Member

@danielchalef danielchalef left a comment

Choose a reason for hiding this comment

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

Grammar gremlins

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Incremental review on e9ba590 in 8 seconds

More details
  • Looked at 13 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. README.md:27
  • Draft comment:
You can install cloud SDK by running:
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The term 'sdk' should be capitalized as 'SDK' for consistency and correctness.
2. README.md:29
  • Draft comment:
npm install @getzep/zep-cloud
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The term 'sdk' should be capitalized as 'SDK' for consistency and correctness. This applies to other instances as well.

Workflow ID: wflow_lAGeq4jWMASvVvHz


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Member

@danielchalef danielchalef left a comment

Choose a reason for hiding this comment

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

lgtm

README.md Outdated Show resolved Hide resolved
Signed-off-by: Daniel Chalef <[email protected]>
Copy link
Member

@danielchalef danielchalef left a comment

Choose a reason for hiding this comment

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

lgtm

@paul-paliychuk paul-paliychuk merged commit ba73bb0 into main Sep 30, 2024
3 checks passed
@paul-paliychuk paul-paliychuk deleted the update-readme-callout branch September 30, 2024 21:37
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