Commands in the docs should include windows commands. #3385
mikeybinns
started this conversation in
Proposals
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Some of the command blocks in the docs are UNIX specific and therefore don't work on windows.
Example: https://remix.run/dashboard/docs/tutorial/nested-routes-params

"touch" is not a command on Windows, and so may confuse windows users, as the command will throw an error.
Any commands should either be platform-agnostic (works on any platform, like mkdir) or should have a windows version.
You could add this by having a dropdown option for Windows, MacOS and Linux. The best example for something like this that I have seen is in the Stripe docs. Here's a screenshot for reference:

The command for
touch app/routes/team.tsx
on windows would beecho "" > app/routes/team.tsx
Beta Was this translation helpful? Give feedback.
All reactions