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

doc: add GenAI cheat sheet #1007

Closed
wants to merge 7 commits into from
Closed

doc: add GenAI cheat sheet #1007

wants to merge 7 commits into from

Conversation

ykharkov
Copy link
Member

@ykharkov ykharkov commented Jun 26, 2024

Issue #, if available:

Description of changes:
Added .md cheat sheet file tailored (and prompt-optimized) for GenAI applications.

Testing done:

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have checked that my tests are not configured for a specific region or account (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Copy link

codecov bot commented Jun 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2f02107) to head (02b1440).
Report is 49 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1007   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          135       135           
  Lines         8941      8949    +8     
  Branches      2008      2011    +3     
=========================================
+ Hits          8941      8949    +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ykharkov ykharkov changed the title Add GenAI cheat sheet feat: Add GenAI cheat sheet Jun 26, 2024
@ykharkov ykharkov changed the title feat: Add GenAI cheat sheet feature: Add GenAI cheat sheet Jun 26, 2024
@ykharkov ykharkov changed the title feature: Add GenAI cheat sheet doc: Add GenAI cheat sheet Jun 26, 2024
@ykharkov ykharkov changed the title doc: Add GenAI cheat sheet doc: add GenAI cheat sheet Jun 26, 2024
@rmshaffer
Copy link
Contributor

@ykharkov thank you for raising this PR. A few questions:

  1. Could you clarify how this relates to feat: publish a cheat sheet via github pages #995, which also adds this file? Should we remove it from that PR, or should these be rolled together?
  2. What is the intended usage of this file? Is there something actively consuming it?
  3. Is there a mechanism we can use to ensure that this file stays up-to-date as the SDK changes?

@ykharkov ykharkov closed this Jun 28, 2024
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