Skip to content

Add beginner onboarding README and teaching comments#1

Open
mariaob1201 wants to merge 1 commit into
open-lambda:mainfrom
mariaob1201:onboarding-readme
Open

Add beginner onboarding README and teaching comments#1
mariaob1201 wants to merge 1 commit into
open-lambda:mainfrom
mariaob1201:onboarding-readme

Conversation

@mariaob1201
Copy link
Copy Markdown

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, the f(event) contract, prerequisites, install-from-git, invoke with curl, and a "now change it" exercise (greet by name from event), plus pointers to the examples/ dir and worker docs.
  • f.py: unchanged behavior (return 'hello'), now with comments explaining the three-line contract for first-time readers.

Verification

f.py still installs and returns "hello":

./ol admin install https://github.com/open-lambda/hello-lambda-example.git
curl -X POST localhost:5000/run/hello-lambda-example -d ''   # -> "hello"

🤖 Generated with Claude Code

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>
@mariaob1201
Copy link
Copy Markdown
Author

@tylerharter would you be able to review/merge this when you get a chance? 🙏

It builds on your existing hello world lambda here, turning the repo into a beginner-friendly onboarding example — the thing the getting-started guide already points newcomers to via ol admin install <git-url>. f.py still returns 'hello'; the PR just adds a walkthrough README and explanatory comments.

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.

1 participant