Skip to content
Open
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ git clone https://github.com/keycloakify/keycloakify-starter

{% tab title="Angular" %}
```bash
git clone https://github.com/keycloakify/keycloakify-starter-angular-vite keycloakify-starter
git clone https://github.com/keycloakify/keycloakify-starter-angular keycloakify-starter-angular-vite
```

Comment on lines 66 to 70
Copy link

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

cd instructions now point to a non-existent directory

The updated clone command checks out into keycloakify-starter-angular-vite, but the global “Quick Start” section still instructs users to
cd keycloakify-starter (line 86). Following the docs verbatim will therefore fail for Angular users.

Please update the subsequent path (and any other hard-coded references) or add Angular-specific instructions inside the tab.

Additionally, footnote [^3] (line 157) still claims that Esbuild is not currently supported—the opposite of this PR’s objective. Make sure the footnote reflects the new default.


🏁 Script executed:

#!/bin/bash
# Display the top of README.md to inspect Quick Start instructions and Angular tab section
sed -n '1,200p' README.md | nl

# Locate occurrences of the Angular clone target directory
rg -n 'keycloakify-starter-angular-vite' README.md

# Locate any 'cd keycloakify-starter' instructions
rg -n 'cd keycloakify-starter' README.md

# Locate footnote [^3] and its content
rg -n '\[\^3\]' -n README.md
sed -n '150,180p' README.md | nl

Length of output: 956


Fix incorrect directory reference and update Esbuild support footnote

The Angular tab’s clone target (keycloakify-starter-angular-vite) doesn’t match the subsequent cd keycloakify-starter instruction (line 86). Following the docs verbatim will fail for Angular users. Also, footnote [^3] (line 157) still states that Esbuild “is not currently supported,” which contradicts this PR’s addition of Esbuild support.

Please address both issues:

• Under the Angular tab (around line 68–86):

  • Replace or augment the cd keycloakify-starter step with:
    cd keycloakify-starter-angular-vite
  • Ensure any other hard-coded paths in that section are Angular-specific.

• Update footnote [^3] (line 157) to reflect that Esbuild support is now available by default (or remove the outdated remark).

🤖 Prompt for AI Agents
In README.md around lines 66 to 86, fix the directory inconsistency by changing
the `cd keycloakify-starter` command to `cd keycloakify-starter-angular-vite`
under the Angular tab to match the clone target. Also, review and update any
other hard-coded paths in this section to be Angular-specific. Additionally, at
line 157, update footnote [^3] to remove or revise the outdated statement that
Esbuild is not supported, reflecting that Esbuild support is now available by
default.

Credit goes to [@kathari00](https://github.com/kathari00) for taking the initiative and driving the development of Angular support.
Expand Down