Skip to content

docs: add a Windows known-issues / troubleshooting section #1170

Description

@oscarbol09

What

Propose adding a docs/WINDOWS_TROUBLESHOOTING.md (or a dedicated section in the README) that centralizes the recurring Windows-specific problems currently being reported, with known symptoms → likely cause → workaround, so new Windows users have somewhere to look before opening a duplicate issue.

Why

The issue tracker currently has a cluster of distinct-looking but related Windows reports, several opened within the same week:

Each is already tracked individually and should stay that way for the actual fixes, but a lot of the diagnostic value (e.g. "if config list fails with cannot open config database, check for non-ASCII in your Windows username — see #1165") is currently locked inside individual issue threads. A short troubleshooting doc would reduce duplicate reports and give maintainers something to link to when triaging new Windows issues.

Proposal

  • New file: docs/WINDOWS_TROUBLESHOOTING.md, linked from the README's existing Troubleshooting table.
  • Structure: one entry per known class of problem (symptom, root cause if known, workaround if one exists, link to the tracking issue), kept in sync as those issues get fixed/closed.
  • Scope is documentation only — no code changes, so it doesn't touch any of the higher-risk areas in MAINTAINERS.md.

Happy to draft the content and open a PR once the location/format is confirmed by a maintainer, per the "open an issue first" contribution guideline.

Metadata

Metadata

Assignees

No one assigned

    Labels

    editor/integrationEditor compatibility and CLI integrationstability/performanceServer crashes, OOM, hangs, high CPU/memorywindowsWindows-specific issues

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions