docs(windows): companion app copy and GitHub auth notes#53788
docs(windows): companion app copy and GitHub auth notes#53788BradGroux merged 1 commit intoopenclaw:mainfrom
Conversation
Greptile SummaryThis PR makes two documentation updates to
Confidence Score: 3/5
Prompt To Fix All With AIThis is a comment left during a code review.
Path: docs/platforms/windows.md
Line: 262-265
Comment:
**`gh auth refresh` inapplicable in the env-var PAT flow**
Step 3 instructs the user to run `gh auth refresh -h github.com -s read:org`, but `gh auth refresh` operates on credentials stored via `gh auth login` — not on the `GH_TOKEN` environment variable set in step 2. Since the whole reason for using the env-var approach is that `gh auth login` failed due to network issues, there are no stored credentials to refresh, and this command will either fail or attempt to re-initiate the browser/device flow on the same blocked network.
The correct resolution in the PAT flow is to create a new token that already includes the `read:org` scope and reassign the variable — not to call `gh auth refresh`. (`gh auth refresh` is the right command only when the user has gone through `gh auth login` and needs to add scopes to a stored OAuth session, which is exactly the path this section works around.)
How can I resolve this? If you propose a fix, please make it concise.Reviews (1): Last reviewed commit: "docs(windows): clarify companion app CTA..." | Re-trigger Greptile |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9c444c6ec9
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
This PR only changes docs/platforms/windows.md. The failing WhatsApp extension-fast tests appear unrelated to this change. If I don't have permission to re-run CI on this repo, a maintainer could re-run the failed jobs. |
|
Addressed Greptile’s note about the PAT env-var flow: when using \GH_TOKEN, we no longer recommend \gh auth refresh. If \gh auth status\ warns about missing |
|
@openclaw-barnacle This PR is now MERGEABLE + CLEAN, and checks are green (or marked as skipping). Also, Greptile’s note about the PAT env-var flow has been addressed in the doc: for the \GH_TOKEN\ path we no longer recommend \gh auth refresh; if \gh auth status\ warns about missing |
|
Codex review: needs changes before merge. Summary Reproducibility: not applicable. this is a docs-only PR, not a runtime bug. The high-confidence check is comparing current main with the PR head and GitHub's mergeability state. Next step before merge Security Review findings
Review detailsBest possible solution: Update the PR branch over current main, preserve main's Windows docs navigation and WSL/source-dev guidance, then let maintainers decide whether to merge the docs addition. Do we have a high-confidence way to reproduce the issue? Not applicable: this is a docs-only PR, not a runtime bug. The high-confidence check is comparing current main with the PR head and GitHub's mergeability state. Is this the best way to solve the issue? Yes after branch update: a one-file docs change is the narrowest maintainable place for this wording and contributor troubleshooting note, provided the conflict resolution keeps current-main content. Full review comments:
Overall correctness: patch is incorrect Acceptance criteria:
What I checked:
Likely related people:
Remaining risk / open question:
Codex review notes: model gpt-5.5, reasoning high; reviewed against 7c0f5463a564. |
446aac5 to
bdb37d7
Compare
|
Maintainer prep done for this docs-only PR. What changed from the stale branch:
Prepared head: Local verification:
CI is green after applying |
Co-authored-by: Brad Groux <3053586+BradGroux@users.noreply.github.com>
Summary
gh auth logindevice flow, and authenticating viaGH_TOKENplusgh auth setup-git, with optionalread:orgrefresh.Why
New contributors on Windows often hit clone/auth timeouts; documenting PAT-based
ghauth reduces friction.Testing
pnpm exec oxfmt --write docs/platforms/windows.mdAI-assisted