feat: publish a cheat sheet via github pages

[jcjaskula-aws]

Issue #, if available:

A cheat sheet is a good way to browse the BDK API to find quickly which functions to use.

Description of changes:

This PR:

• adds the source for a cheat sheet based on jekyll.
• adds a CI action that build and publish the cheat sheet on github pages
• adds a script that goes through all the sections of the cheat sheet and create a single markdown file to feed genAI agent
  • it uses html comments to optimize the cheat sheet (adding additional information that we might not want to publish in the cheat sheet to keep it clean)
  • it adds the markdown file at the root of the website and can be vended via url/genAI_optimized_cheat_sheet.md

Testing done:

N/A

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

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

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d5dfbf4) to head (1127b8d).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #995   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          135       135           
  Lines         8919      8941   +22     
  Branches      2002      2008    +6     
=========================================
+ Hits          8919      8941   +22     

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

[math411]

Should we add a condition to skip the deployment if it is a pull-request: if: github.event_name != 'pull_request'?

[rmshaffer]

It is configured to only run after a push to main - I think this would automatically exclude pull requests?

amazon-braket-sdk-python/.github/workflows/publish-cheat-sheet.yml

Lines 3 to 6 in 9fe7082

	on:
	push:
	branches:
	- main

[math411]

Seems the action is able to be executed from a branch: https://github.com/amazon-braket/amazon-braket-sdk-python/actions/runs/9390972449/job/25959406913

[rmshaffer]

Oh, I see, it can be manually executed. Yes, that should be fixed, thanks for catching that.

[jcjaskula-aws]

It ran automatically the first time too. Wonder if it because it targets main.