documentation: add SDK cheat sheet#1268
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1268 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 169 169
Lines 10964 10964
Branches 1413 1413
=========================================
Hits 10964 10964 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
The jekyll bundle is failing. Please include detailed instructions in the Readme on how to make it work. |
|
Thanks for flagging this. I pushed a follow-up in I also re-ran the markdown generator locally and confirmed the generated output matches |
|
Thanks. I installed Ruby 4.0.5, but this command gave me an error: Please add more details to the instructions so I can follow them. |
|
Thanks for testing it on Ruby 4. I pushed a follow-up in What changed:
Validation I ran locally:
|
Issue #, if available:
Closes #1255
Description of changes:
Testing done:
python3 doc/cheat_sheet/_scripts/generate_markdown.pypython3 -m compileall doc/cheat_sheet/_scripts/generate_markdown.pydoc/genai_cheat_sheet.mdmatches the generator output.doc/cheat_sheet/_data/blocks.ymlhas a matching English include.git diff --check.venv/bin/tox -e docs.venv/bin/tox -e linters_checkunitaryHACK26:
I used GPT-5 Codex to help draft and check the documentation structure and snippets, then manually verified them against the current SDK source/examples and ran the checks above.
Merge Checklist
Put an
xin 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
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.