Skip to content
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

Jump to bottom

Fix getting started docs for windows users #3703

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix getting started docs for windows users #3703

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6c08f1
Resolve error for windows users: Access is denied. (os error 5)
JurrianFahner Aug 3, 2024
d4373cd
Add note for trunk windows bug
JurrianFahner Aug 18, 2024
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
18 changes: 17 additions & 1 deletion website/docs/getting-started/build-a-sample-app.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,28 @@ the boilerplate needed for a basic Yew app or manually set up a small project.
## Using a starter template

Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) by following their installation instructions
then run the following command:
then take the following steps:

### Checkout and customize project

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

### Build project

This step is only needed when this guide has been run on Microsoft windows.

```shell
trunk build
```
Copy link
Member

Choose a reason for hiding this comment

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

This feels like a trunk bug if it requires build before serve on windows

Copy link
Author

Choose a reason for hiding this comment

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

I agree, it is a trunk bug on windows.
But at this moment in time on windows, the guide leads to an error.

Copy link
Member

Choose a reason for hiding this comment

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

I'm not happy with documenting a bug here like this. Ideally, the bug should be fixed, or be documented for Trunk.

To give a JS equivalent, this feels like react docs telling users to run vite build before vite dev on windows (which is also bad)

Copy link
Author

Choose a reason for hiding this comment

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

I understand your position. I had mixed feelings too. But the getting started guide is now not working. Is it in idea to replace it in the following way (below the serve command):

Note
In trunk there is a bug on windows when trunk serve command fails. To workaround the issue you can run trunk build first.


### Run project

```shell
trunk serve
```

## Setting up the application manually

### Create Project
Expand Down
18 changes: 17 additions & 1 deletion website/versioned_docs/version-0.21/getting-started/build-a-sample-app.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,28 @@ the boilerplate needed for a basic Yew app or manually set up a small project.
## Using a starter template

Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) by following their installation instructions
then run the following command:
then take the following steps:

### Checkout and customize project

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

### Build project

This step is only needed when this guide has been run on Microsoft windows.

```shell
trunk build
```

### Run project

```shell
trunk serve
```

## Setting up the application manually

### Create Project
Expand Down
Loading