Skip to content

docs: fix frontend build sequence and add Windows compatibility note#1169

Open
TanXudong-Vivo wants to merge 4 commits intogoogle:mainfrom
TanXudong-Vivo:docs/fix-restaurant-finder-build-order
Open

docs: fix frontend build sequence and add Windows compatibility note#1169
TanXudong-Vivo wants to merge 4 commits intogoogle:mainfrom
TanXudong-Vivo:docs/fix-restaurant-finder-build-order

Conversation

@TanXudong-Vivo
Copy link
Copy Markdown

@TanXudong-Vivo TanXudong-Vivo commented Apr 14, 2026

Description

This PR fixes a logical error in the "Running the Restaurant Finder demo" section of the README.

What changed

  • Reordered the frontend build steps so that renderers/web_core is built before renderers/markdown/markdown-it
  • Added a troubleshooting note for Windows users about manually installing @rollup/rollup-win32-x64-msvc if needed

Why

@a2ui/markdown-it depends on @a2ui/web_core. In the current README order, building markdown-it first can result in:

TS2307: Cannot find module '@a2ui/web_core'

Additionally, on Windows environments, npm install may fail to install Rollup's optional native dependency, which can cause the npm run dev step to fail unless @rollup/rollup-win32-x64-msvc is installed manually.

Verification

Verified on a clean Windows environment:

  • Before: building markdown-it first failed with TypeScript errors
  • After: following the new sequence (web_core -> markdown-it -> lit -> shell) completed successfully
  • The Vite dev server started successfully at http://localhost:5173/

Closes #1168

Pre-launch Checklist

  • I signed the [CLA].
  • I read the [Contributors Guide].
  • I read the [Style Guide].
  • I have added updates to the [CHANGELOG].
  • I updated/added relevant documentation.
  • My code changes (if any) have tests.

@google-cla
Copy link
Copy Markdown

google-cla Bot commented Apr 14, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Copy link
Copy Markdown
Contributor

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

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 to reorder and number the build steps for the samples, ensuring the Web Core library is built first. It also adds a troubleshooting note for Windows users regarding the @rollup/rollup-win32-x64-msvc module. I have no feedback to provide.

@TanXudong-Vivo TanXudong-Vivo force-pushed the docs/fix-restaurant-finder-build-order branch from 8b07c6f to c8b5f68 Compare April 14, 2026 02:32
@TanXudong-Vivo TanXudong-Vivo force-pushed the docs/fix-restaurant-finder-build-order branch from 9a1ede8 to d047847 Compare April 15, 2026 01:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

Docs: Build sequence error and Windows compatibility issue in Restaurant Finder demo

2 participants