-
Notifications
You must be signed in to change notification settings - Fork 2.5k
docs: add a Windows known-issues / troubleshooting section #1170
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestpriority/normalStandard review queue; useful PR with ordinary maintainer urgency.Standard review queue; useful PR with ordinary maintainer urgency.ux/behaviorDisplay bugs, docs, adoption UXDisplay bugs, docs, adoption UXwindowsWindows-specific issuesWindows-specific issues
Milestone
Description
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestpriority/normalStandard review queue; useful PR with ordinary maintainer urgency.Standard review queue; useful PR with ordinary maintainer urgency.ux/behaviorDisplay bugs, docs, adoption UXDisplay bugs, docs, adoption UXwindowsWindows-specific issuesWindows-specific issues
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:
CBM_CACHE_DIR/CBM_ALLOWED_ROOTlossily decoded (non-ASCII → U+FFFD), causing silent path divergence or hard failurescodebase-memory-mcp upgradereports success but the binary version doesn't actually changesettings.jsoninstead of the Antigravity 2.0 modular config, and can leave duplicate 273MB binaries on diskinstallfails to detect OpenCode on Windows even when both the CLI and app are installedEach is already tracked individually and should stay that way for the actual fixes, but a lot of the diagnostic value (e.g. "if
config listfails withcannot 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
docs/WINDOWS_TROUBLESHOOTING.md, linked from the README's existing Troubleshooting table.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.