Skip to content

docs: fix deploy instructions to match actual netlify hosting #546

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

Merged
hami-robot merged 1 commit into from
Jul 6, 2026
+4 −12
Merged

docs: fix deploy instructions to match actual netlify hosting #546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 6 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,9 @@ npm run build:fast # build English locale only (skips zh, for quick iteration

CI (`.github/workflows/docs-health.yml`) runs `lint`, `format:check`, and `build` on every PR.

### Deploy to GitHub Pages
### Deployment

```bash
GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy
```

Builds and deploys the website to the `gh-pages` branch for GitHub Pages hosting.
The site deploys automatically to Netlify on every merge to `master` (see `netlify.toml`). No manual deploy step is needed.

## Commit Convention

Expand Down
8 changes: 2 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,7 @@ See [BUILD_OPTIMIZATION.md](./BUILD_OPTIMIZATION.md) for details on optimization

## Deployment

For GitHub Pages (requires appropriate permissions):

```bash
GIT_USER=<your_github_username> USE_SSH=true npm run deploy
```
The site deploys automatically to Netlify on every merge to `master` (see `netlify.toml`). No manual deploy step is needed.

For other hosting services, deploy the `build/` directory as a static site.

Expand Down Expand Up @@ -170,7 +166,7 @@ To contribute translations, update the corresponding files in `i18n/zh/`.
- **Compiler**: SWC
- **Runtime**: Node.js v20+
- **Package Manager**: npm
- **Hosting**: GitHub Pages / Netlify
- **Hosting**: Netlify

## Maintainers

Expand Down
Loading