doc: add GenAI cheat sheet

ykharkov commented 1 week ago

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

[x] I have read the CONTRIBUTING doc
[x] I used the commit message format described in CONTRIBUTING
[x] I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

[x] I have added tests that prove my fix is effective or that my feature works (if appropriate)
[x] 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.

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #1007 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 135 135 Lines 8941 8949 +8 Branches 2008 2011 +3 ========================================= + Hits 8941 8949 +8 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

rmshaffer commented 1 week ago

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

Could you clarify how this relates to https://github.com/amazon-braket/amazon-braket-sdk-python/pull/995, which also adds this file? Should we remove it from that PR, or should these be rolled together?
What is the intended usage of this file? Is there something actively consuming it?
Is there a mechanism we can use to ensure that this file stays up-to-date as the SDK changes?

amazon-braket / amazon-braket-sdk-python