Skip to content

[improve] Update README to reflect Vite migration #118

Description

@github-actions

What

Update README.md to accurately reflect the current Vite-based development workflow.

Why

The README still referenced Vue CLI commands (npm run serve, (cli.vuejs.org/redacted) from before the Vite migration. Any developer cloning the repo and following the README would run npm run serve— which does not exist — instead ofnpm run dev`.

How

  • Replace npm run servenpm run dev
  • Add npm run preview (missing from docs)
  • Note that npm run build outputs to docs/ for GitHub Pages
  • Update config reference link from Vue CLI to Vite docs
  • Remove stale BrowserStack badge/link (broken URL)

Before / After

Before:

### Compiles and hot-reloads for development
npm run serve

See Configuration Reference: (cli.vuejs.org/redacted)

After:

### Start development server (hot-reload)
npm run dev

See Vite Configuration Reference: (vite.dev/redacted)

Verification

  • npm run build passes
  • npm run lint passes
  • Change is backward-compatible
  • No existing PR conflicts

Warning

Protected Files — Push Permission Denied

This was originally intended as a pull request, but the patch modifies protected files. A human must create the pull request manually.

Protected files
  • README.md

The push was rejected because GitHub Actions does not have workflows permission to push these changes, and is never allowed to make such changes, or other authorization being used does not have this permission.

Create the pull request manually
# Download the patch from the workflow run
gh run download 26181916081 -n agent -D /tmp/agent-26181916081

# Create a new branch
git checkout -b docs-update-readme-for-vite-398331539a8e4c6d main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-26181916081/aw-docs-update-readme-for-vite.patch

# Push the branch and create the pull request
git push origin docs-update-readme-for-vite-398331539a8e4c6d
gh pr create --title '[improve] Update README to reflect Vite migration' --base main --head docs-update-readme-for-vite-398331539a8e4c6d --repo kaovilai/kaovilai.pw

Generated by Continuous Improvement — Portfolio Site · ● 19.9M ·

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions