gitbutler icon indicating copy to clipboard operation
gitbutler copied to clipboard

Inclusion of troubleshooting information on developer docs

Open trekie86 opened this issue 1 year ago • 1 comments

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 https://github.com/vercel/turborepo/issues/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

trekie86 avatar Oct 02 '24 22:10 trekie86

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?

Byron avatar Oct 03 '24 06:10 Byron

I can send a PR adding a Troubleshooting section (case-sensitive volume, Turbo daemon fixes, cache notes, links).

ali90h avatar Aug 12 '25 22:08 ali90h