Skip to content

fix(readme.md): reorder installation steps in README.md#850

Open
amilamen wants to merge 2 commits intogoogle:mainfrom
amilamen:patch-1
Open

fix(readme.md): reorder installation steps in README.md#850
amilamen wants to merge 2 commits intogoogle:mainfrom
amilamen:patch-1

Conversation

@amilamen
Copy link

@amilamen amilamen commented Mar 13, 2026

markdown-it build requires dependencies in web_core like "@a2ui/web_core": "file:../../web_core"

Description

markdown-it build requires dependencies in web_core like "@a2ui/web_core": "file:../../web_core".
Without that, npm run build on markdown-it project failed.

Pre-launch Checklist

If you need help, consider asking for advice on the discussion board.

markdown-it build requires dependencies in web_core like "@a2ui/web_core": "file:../../web_core"
Copy link
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 correctly reorders the installation steps in the README.md to address a dependency issue. However, the cd commands were not updated to reflect the new order, which breaks the sequence of shell commands. I've provided a review comment with a suggested fix for the changed lines and a note about a necessary follow-up change to make the instructions work correctly.

Comment on lines +137 to 145
# Install and build the Web Core library
cd ../../web_core
npm install
npm run build

# Install and build the Web Core library
cd ../../web_core
# Install and build the Markdown renderer
cd renderers/markdown/markdown-it
npm install
npm run build
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

While the intention to reorder the build steps is correct, simply swapping the blocks has broken the directory navigation, as the cd commands are relative. The cd paths are now incorrect and will cause the setup instructions to fail.

This suggestion corrects the paths for building web_core and then markdown-it.

Please note that the next step for building the 'Lit renderer' will also need its cd command updated to be relative to the new working directory (e.g., cd ../../lit).

Suggested change
# Install and build the Web Core library
cd ../../web_core
npm install
npm run build
# Install and build the Web Core library
cd ../../web_core
# Install and build the Markdown renderer
cd renderers/markdown/markdown-it
npm install
npm run build
# Install and build the Web Core library
cd renderers/web_core
npm install
npm run build
# Install and build the Markdown renderer
cd ../markdown/markdown-it
npm install
npm run build

Update directory paths for Web Core and Markdown renderer
@amilamen amilamen changed the title Reorder installation steps in README.md (fix)readme.md : reorder installation steps in README.md Mar 13, 2026
@amilamen amilamen changed the title (fix)readme.md : reorder installation steps in README.md fix(readme.md): reorder installation steps in README.md Mar 13, 2026
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.

1 participant