Fix getting started docs for windows users #3703
Conversation
| ### Build project | ||
|
|
||
| This step is only needed when this guide has been run on Microsoft windows. | ||
|
|
||
| ```shell | ||
| trunk build | ||
| ``` |
There was a problem hiding this comment.
This feels like a trunk bug if it requires build before serve on windows
There was a problem hiding this comment.
I agree, it is a trunk bug on windows.
But at this moment in time on windows, the guide leads to an error.
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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 whentrunk servecommand fails. To workaround the issue you can runtrunk buildfirst.
| > **Note** | ||
| 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`. | ||
|
|
There was a problem hiding this comment.
This sounds reasonable. It would be better if you used https://docusaurus.io/docs/markdown-features/admonitions though
Description
Resolve error for windows users: Access is denied. (os error 5)
It looks like this error is related to windows: trunk-rs/trunk#681
Also trunk serve is added to conclude getting started with starter template
Checklist