Skip to content

docs(troubleshooting): add Windows troubleshooting guide - #2717

Open
oscarbol09 wants to merge 2 commits into
DeusData:mainfrom
oscarbol09:docs/windows-troubleshooting
Open

oscarbol09 wants to merge 2 commits into
DeusData:mainfrom
oscarbol09:docs/windows-troubleshooting

Conversation

@oscarbol09

Copy link
Copy Markdown

What does this PR do?

Adds \docs/WINDOWS_TROUBLESHOOTING.md\ and links it from the README Troubleshooting table, fulfilling the proposal agreed in #1170.

Each entry documents:

  • Confirmed symptom
  • Affected version ranges
  • Current workaround
  • Canonical tracking issue

The entries reflect verified status against v0.10.x and v0.11.0 (clarifying that earlier root-cause fixes such as wide-string environment variable decoding and out-of-process update handling apply to v0.10.0+, while keeping open issues like #1130 and #1145 actionable for triage).

Refs #1170

Note: Drafted with AI assistance (Antigravity/Gemini) on behalf of Oscar Madera (@oscarbol09).

Checklist

  • Every commit is signed off (\git commit -s) — required, CI rejects unsigned commits (DCO, see CONTRIBUTING.md)
  • Documentation-only change (no C code or build infrastructure modified)

Centralize recurring Windows-specific troubleshooting entries in a dedicated document linked from README.md. Each entry includes confirmed symptoms, affected version ranges, current workarounds, and canonical tracking issue references, updated to reflect v0.10.x and v0.11.0 status.

Refs DeusData#1170

Signed-off-by: Oscarbol09 <omaderabolano@correo.unicordoba.edu.co>
@DeusData

Copy link
Copy Markdown
Owner

Thank you, @oscarbol09, for following through on the proposal you opened in #1170, and for shaping every entry exactly the way it was agreed there: confirmed symptom, affected versions, workaround and tracking issue. We are reviewing it now. One thing we need to settle on our side first: an earlier pull request for the same page (#2262) is still open, and we want both contributions credited fairly before we land one. We will come back shortly with the outcome and a few small wording updates, since a couple of entries changed with v0.12.0. Nothing is needed from you in the meantime.

@github-actions

Copy link
Copy Markdown

Thanks for opening this — it has been seen, and it is queued.

This note is automated, but it is not a brush-off: it exists so you know where your PR stands instead of having to guess from silence.

Current review status: working through a backlog. 0.9.1-rc.1 is out, so the release freeze that held reviews is over — but it left a large queue of open pull requests behind it, and we are reading through them oldest-first. The background is in discussion #1144.

What that means for this PR, concretely:

  • It will not be closed for inactivity. No stale bot touches pull requests here.
  • It may still sit a while before a human reads it. That is on us, not on you.
  • Older PRs are read first, so a recent one is not being skipped — it is behind a queue.

Things that will genuinely speed it up whenever review does happen:

  • Keep it rebased on main — the tree is moving quickly right now, and a conflicting branch cannot be reviewed as the diff you intended.
  • Get CI green, or say which failures you believe are pre-existing.
  • Keep the change to one claim. Bundled features and refactors get split before they get merged, which costs you a round trip.
  • Every commit needs a sign-off (git commit -s) — CI enforces DCO.

If this fixes a bug, a reproduction we can run is worth more than a description of the symptom.

Thanks for contributing, and sorry in advance for the wait.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants