Repository navigation
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the README.md for the Lit shell sample to clarify prerequisites (including Python and Gemini API key setup) and provides two options for running the agent and dev server. The review feedback recommends adding comments to clarify that command blocks should be run from the repository root to avoid directory context confusion, and formatting the local URL as a clickable markdown link.
parvezk
marked this pull request as ready for review
October 26, 2026 20:03
parvezk
force-pushed
the
docs/lit-shell-readme-scripts
branch
from
October 26, 2026 20:23
e6062c9 to
baca8dc
Compare
This branch has not been deployed
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.
Description
Rewrites the run instructions in
samples/client/lit/shell/README.md. A first-time user following them can hit two problems.GEMINI_API_KEY. As a result, the agent exits at startup. The README now lists both prerequisites and shows how to either export the key or copy the agent's.env.exampleto.env, as the React and Angular sample READMEs already do.demo:restaurantscripts. Insamples/client/lit,yarn demo:restaurantbuilds the renderer and runs the shell and the agent together, which is what the Quickstart uses. Insamples/client/lit/shell, the README's directory,yarn demo:restaurantstarts only the Python agent and blocks, andyarn devhas to run in a second terminal. The README listed both commands as bullets with no indication of this. It now documents both ways: Option A is the single command fromsamples/client/lit, and Option B is the two-terminal setup fromsamples/client/lit/shell.The README also gives the UI's URL (
http://localhost:5173).Testing
prettier --check samples/client/lit/shell/README.mdpasses.samples/client/lit/package.jsonandsamples/client/lit/shell/package.json.Pre-launch Checklist
One time:
For this PR: