Skip to content

Commit d03f163

Browse files
committed
docs(site): refine setup flow and sync guidance
1 parent 25a368e commit d03f163

4 files changed

Lines changed: 20 additions & 9 deletions

File tree

docs-site/docs/.vitepress/config.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ export default defineConfig({
44
lang: 'en-US',
55
title: 'PWAKit',
66
description: 'Wrap your Progressive Web App in a native iOS shell with a typed JavaScript bridge.',
7+
base: '/pwa-kit/',
78
cleanUrls: true,
89
lastUpdated: true,
910
themeConfig: {

docs-site/docs/cli/overview.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,19 @@ Recommended (no global install):
1111

1212
```bash
1313
npx @pwa-kit/cli init my-pwa-ios
14-
cd my-pwa-ios && npx @pwa-kit/cli sync
1514
```
1615

1716
Optional global install:
1817

1918
```bash
2019
npm install -g @pwa-kit/cli
21-
pwa-kit init
22-
pwa-kit sync
20+
pwa-kit init my-pwa-ios
21+
```
22+
23+
Run `sync` after manual edits to `pwa-config.json`:
24+
25+
```bash
26+
cd my-pwa-ios && npx @pwa-kit/cli sync
2327
```
2428

2529
## No-clone workflow

docs-site/docs/guide/development-workflow.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@ This page describes the standard workflow for shipping updates to your wrapped P
1313
## Configuration change flow
1414

1515
```bash
16-
npx @pwa-kit/cli init . --force # optional: re-run setup in current project
1716
npx @pwa-kit/cli sync
1817
```
1918

19+
If you re-run setup with `npx @pwa-kit/cli init . --force`, sync is already included.
20+
2021
Then in Xcode:
2122

2223
1. Build (`Cmd+B`).

docs-site/docs/help/faq.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,18 @@ Yes. Native features are additive; your web app can still run in a standard brow
3434

3535
Use `SecureStorageModule` (Keychain-backed) rather than embedding keys in source.
3636

37-
## How should I run setup and sync commands?
37+
## How should I run setup commands?
3838

3939
Use the CLI directly:
4040

4141
```bash
42-
mkdir my-pwa-ios
43-
cd my-pwa-ios
44-
npx @pwa-kit/cli init
45-
npx @pwa-kit/cli sync
42+
npx @pwa-kit/cli init my-pwa-ios
43+
```
44+
45+
`init` already runs sync automatically.
46+
47+
Run `sync` later only after manual edits to `pwa-config.json`:
48+
49+
```bash
50+
cd my-pwa-ios && npx @pwa-kit/cli sync
4651
```

0 commit comments

Comments
 (0)