Skip to content

docs(samples): clarify API key setup and run commands in the Lit shell README - #3419

Open
parvezk wants to merge 3 commits into
a2ui-project:mainfrom
parvezk:docs/lit-shell-readme-scripts
Open

parvezk wants to merge 3 commits into
a2ui-project:mainfrom
parvezk:docs/lit-shell-readme-scripts

Conversation

@parvezk

@parvezk parvezk commented Oct 22, 2026 •

Copy link
Copy Markdown

Description

Rewrites the run instructions in samples/client/lit/shell/README.md. A first-time user following them can hit two problems.

  1. No API key step. The prerequisites list Node.js and uv but not Python or a Gemini API key, and there is no step that sets 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.example to .env, as the React and Angular sample READMEs already do.
  2. Two different demo:restaurant scripts. In samples/client/lit, yarn demo:restaurant builds the renderer and runs the shell and the agent together, which is what the Quickstart uses. In samples/client/lit/shell, the README's directory, yarn demo:restaurant starts only the Python agent and blocks, and yarn dev has 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 from samples/client/lit, and Option B is the two-terminal setup from samples/client/lit/shell.

The README also gives the UI's URL (http://localhost:5173).

Testing

  • prettier --check samples/client/lit/shell/README.md passes.
  • Checked the commands and relative links against samples/client/lit/package.json and samples/client/lit/shell/package.json.

Pre-launch Checklist

One time:

For this PR:

  • I have updated the relevant CHANGELOG.md file.
  • I updated/added relevant documentation.
  • My code changes (if any) have tests.
  • If my branch is on a fork, I have verified that scripts/e2e_test.sh passes.

@github-project-automation github-project-automation Bot moved this to Todo in A2UI Oct 22, 2026
@github-actions github-actions Bot added the status: needs-triage auto-managed: https://github.com/a2ui-project/a2ui/blob/main/scripts/triage.mjs label Oct 22, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread samples/client/lit/shell/README.md Resolved
Comment thread samples/client/lit/shell/README.md Resolved
Comment thread samples/client/lit/shell/README.md Resolved
Comment thread samples/client/lit/shell/README.md Resolved
@parvezk
parvezk marked this pull request as ready for review October 26, 2026 20:03
@parvezk
parvezk force-pushed the docs/lit-shell-readme-scripts branch from e6062c9 to baca8dc Compare October 26, 2026 20:23

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: needs-triage auto-managed: https://github.com/a2ui-project/a2ui/blob/main/scripts/triage.mjs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant