Skip to content

Commit 57b29f2

Browse files
Fix getting started docs for windows users (#3703)
* Add note for trunk windows bug
1 parent 4a28de4 commit 57b29f2

2 files changed

Lines changed: 30 additions & 2 deletions

File tree

website/docs/getting-started/build-a-sample-app.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,26 @@ the boilerplate needed for a basic Yew app or manually set up a small project.
88
## Using a starter template
99

1010
Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) by following their installation instructions
11-
then run the following command:
11+
then take the following steps:
12+
13+
### Checkout and customize project
1214

1315
```shell
1416
cargo generate --git https://github.com/yewstack/yew-trunk-minimal-template
1517
```
1618

19+
### Run project
20+
21+
```shell
22+
trunk serve
23+
```
24+
25+
:::note
26+
27+
Trunk [has a bug](https://github.com/trunk-rs/trunk/issues/852) on windows when `trunk serve` command fails. To workaround the issue you can run `trunk build` before running `trunk serve`.
28+
29+
:::
30+
1731
## Setting up the application manually
1832

1933
### Create Project

website/versioned_docs/version-0.21/getting-started/build-a-sample-app.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,26 @@ the boilerplate needed for a basic Yew app or manually set up a small project.
88
## Using a starter template
99

1010
Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) by following their installation instructions
11-
then run the following command:
11+
then take the following steps:
12+
13+
### Checkout and customize project
1214

1315
```shell
1416
cargo generate --git https://github.com/yewstack/yew-trunk-minimal-template
1517
```
1618

19+
### Run project
20+
21+
```shell
22+
trunk serve
23+
```
24+
25+
:::note
26+
27+
Trunk [has a bug](https://github.com/trunk-rs/trunk/issues/852) on windows when `trunk serve` command fails. To workaround the issue you can run `trunk build` before running `trunk serve`.
28+
29+
:::
30+
1731
## Setting up the application manually
1832

1933
### Create Project

0 commit comments

Comments
 (0)