Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amilamen wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5d89ee
Reorder installation steps in README.md
amilamen Mar 13, 2026
7344556
Update directory paths for Web Core and Markdown renderer
amilamen Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,13 +134,13 @@ The best way to understand A2UI is to run the samples.
Open a new terminal window:

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

# Install and build the Web Core library
cd ../../web_core
# Install and build the Markdown renderer
cd ../markdown/markdown-it
npm install
npm run build
Comment on lines +137 to 145
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Mar 13, 2026

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


Expand Down