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.

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

Inclusion of troubleshooting information on developer docs #5025

Open
trekie86 opened this issue Oct 2, 2024 · 1 comment
Open

Inclusion of troubleshooting information on developer docs #5025

trekie86 opened this issue Oct 2, 2024 · 1 comment

Comments

@trekie86
Copy link

trekie86 commented Oct 2, 2024

What is the improvement or update you wish to see?

The DEVELOPMENT.md doc covers most issues but it doesn't provide the most support on troubleshooting beyond the debugger. I was attempting to run the dev:desktop target and was pulling my hair out getting the application to start. After a lot of searching, I stumbled upon vercel/turborepo#8491 that seems to highlight a problem with case-sensitive volumes when running with Turbo.

So while yes it would be expected that developers can navigate the tool chain to find the reasons they can't execute targets, I wonder if there is anything specific that can be added around system configuration, etc. that may help reduce churn. I realize the problem is with Turbo but even a section that points to the GitHub issues list for each major component (Turbo, Tauri, Svelte, etc.) may reduce the effort required to figure out why something is wrong.

Is there any context that might help us understand?

No response

Does the docs page already exist? Please link to it.

No response

@Byron
Copy link
Collaborator

Byron commented Oct 3, 2024

Thanks a lot for sharing, I am glad it worked out in the end. Also, I think improving the onboarding experience for a source-available project is very important, particularly for a developer tool.

Do you think it makes sense for you to add the trouble-shooting section that you would have wanted to see to DEVELOPMENT.md in a PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants