docs: add Windows setup and troubleshooting guide - #87
Draft
aryansk wants to merge 1 commit into
Draft
Conversation
Covers native Windows, WSL2, and Git Bash installs, env-file paths, and the known POSIX limitations of execute_bash/git tools. Links the guide from the README install section. Closes shauryagangrade#74.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
There is no Windows guidance at all: install, WSL vs native, bash/git
availability, and the known limitations (see the
execute_bashbug, #54)are undocumented. Closes #74.
Change
Adds
docs/windows.mdcovering:C:\Users\<you>\.gcode\.env) and where.gcoderc/ session history live.execute_bashusescmd.exeon native Windows(bash syntax fails, tracked in [Bug]: execute_bash and git tools assume POSIX/bash — broken on native Windows #54), git tools need Git for Windows,
and the
greppure-Python fallback.Links the guide from the README install section.
Why this approach
Docs-only, no behavior change. The guide documents the current story
honestly (WSL2 works fully; native Windows has real
execute_bashlimits) instead of overclaiming Windows support that does not exist yet.
Testing
git diff --checkclean.(
bug_report.ymltemplate, READMEConfiguration fileanchor).Documentation and release impact
Review notes
execute_bashremains broken (bashsyntax via cmd.exe); this guide documents it and points at [Bug]: execute_bash and git tools assume POSIX/bash — broken on native Windows #54.