From 478138e2885c8eca0799f90e7377f14b6fedaaa9 Mon Sep 17 00:00:00 2001 From: Tianworld <40754565+Tianworld@users.noreply.github.com> Date: Tue, 5 May 2026 13:31:03 +0800 Subject: [PATCH] docs(windows): update GitHub connectivity notes (#53788) Co-authored-by: Brad Groux <3053586+BradGroux@users.noreply.github.com> --- docs/platforms/windows.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/docs/platforms/windows.md b/docs/platforms/windows.md index cba75a5f1a7..a2f45ac0101 100644 --- a/docs/platforms/windows.md +++ b/docs/platforms/windows.md @@ -245,8 +245,40 @@ Full guide: [Getting Started](/start/getting-started) ## Windows companion app -We do not have a Windows companion app yet. Contributions are welcome if you want -contributions to make it happen. +We do not have a Windows companion app yet. Contributions are welcome if you want to +help make it happen. + +## Git and GitHub connectivity (contributors) + +Some networks block or throttle HTTPS to GitHub. If `git clone` fails with timeouts +or connection resets, try another network, a VPN, or an HTTP/HTTPS proxy your +organization provides. + +If `gh auth login` fails during the browser device flow (for example a timeout +reaching `github.com:443`), authenticate with a personal access token instead: + +1. Create a token with at least the `repo` scope (classic PAT) or equivalent + fine-grained access. +2. In PowerShell for the current session: + +```powershell +$env:GH_TOKEN="" +gh auth status +gh auth setup-git +``` + +3. If `gh auth status` warns about missing `read:org`, mint a token that includes + that scope and re-assign the variable: + +```powershell +$env:GH_TOKEN="" +gh auth status +``` + +`gh auth refresh -s read:org` only applies when you authenticated via `gh auth login` +and have stored credentials to refresh (not when using `GH_TOKEN`). + +Never commit tokens or paste them into issues or pull requests. ## Related