superfly/docs

Paragraph might confuse users

redjonzaci opened this issue · 4 comments

redjonzaci commented

It confused me at least. Should we maybe:

  • explain why we have this or
  • move it to a details section with the summary being the reason why this is included or
  • move it to a Troubleshooting page and link to it?
image
rubys commented

flyctl is written in go. There are go libraries that you can import like https://github.com/skratchdot/open-golang which will "open" an application or a browser. If you look at the description for that library, you can see that it runs a different command based on the operating system.

This library detects WSL as linux (which is it) and tries to run xdg-open, which is not included in WSL. WSL includes wslview which will open a browser window and by creating xdg-open as a symbolic link to wslview you can get flyctl to open a browser window on WSL.

  • 👍1
redjonzaci commented

Okay, I understand now and I feel like adding this info to the docs would help.
What do you think @andie787?

rubys commented

This information current exists on two pages:

My sense is that people who land on those pages are looking to solve a problem, and are not looking for a deep explanation.

redjonzaci commented

But it doesn't explain what you explained to me or at least say: "if you have this error message, do this...".

Why is that important? Because I am left there wondering if I need to run the command or not.

I mean it's not that important, but just sharing my perspective.