Add beginner onboarding README and teaching comments#1
Open
mariaob1201 wants to merge 1 commit into
Open
Conversation
Turn the bare hello-world into an intro example for people new to OpenLambda (and to programming): a walkthrough README covering what a lambda is, how to install it from this repo, how to invoke it with curl, and a "now change it" exercise. f.py keeps returning 'hello' but gains comments explaining the f(event) contract. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Author
|
@tylerharter would you be able to review/merge this when you get a chance? 🙏 It builds on your existing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Makes this repo a proper "initiate people to programming with OpenLambda" example, as the canonical thing to point newcomers to (it's already referenced by the getting-started guide as the
ol admin install <git-url>demo).Changes
README.md(new): a beginner walkthrough — what a lambda is, thef(event)contract, prerequisites, install-from-git, invoke withcurl, and a "now change it" exercise (greet by name fromevent), plus pointers to theexamples/dir and worker docs.f.py: unchanged behavior (return 'hello'), now with comments explaining the three-line contract for first-time readers.Verification
f.pystill installs and returns"hello":🤖 Generated with Claude Code