Skip to content

Commit c14e7ba

Browse files
committed
Improve WSL documentation formatting in README
Reformatted the 'How it works' and 'Troubleshooting WSL' sections using collapsible details for better readability and organization.
1 parent c8af128 commit c14e7ba

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,26 @@ This package supports WSL environments where PhpStorm runs on native Windows and
2828
- Check if installed: `wslvar -v`
2929
- Install if needed: `sudo apt install wslu`
3030

31-
#### How it works
31+
<details>
32+
<summary>How it works</summary>
33+
3234
1. **Detection**: Automatically detects WSL environment by checking `WSL_DISTRO_NAME` environment variable
3335
2. **Username Resolution**: Uses `wslvar USERNAME` to get Windows username (WSL and Windows usernames may differ)
3436
3. **File Writing**: Writes MCP config to Windows side via PowerShell commands
3537
- Creates temporary file in Windows `%TEMP%` directory
3638
- Uses Base64 encoding to safely transfer JSON content
3739
- Copies to final location: `%LOCALAPPDATA%\github-copilot\intellij\mcp.json`
3840
4. **Path Handling**: Converts WSL paths to Windows paths for absolute command and artisan paths
41+
</details>
42+
43+
<details>
44+
<summary>Troubleshooting WSL</summary>
3945

40-
#### Troubleshooting WSL
4146
- Ensure `wslu` is installed and `wslvar` command works
4247
- Check that PowerShell is accessible from WSL with `powershell.exe -Command "Write-Output 'test'"`
4348
- Verify Windows username with `wslvar USERNAME`
4449
- If MCP config file is not created, check Windows directory permissions
50+
</details>
4551

4652
#### Alternative for WSL
4753
If you encounter issues with WSL setup, consider using [laravel-boost-copilot-cli](https://github.com/invokable/laravel-boost-copilot-cli) which uses a different approach better suited for some WSL configurations.

0 commit comments

Comments
 (0)