docs(xai-oauth): note bare-code manual-paste form (#33917)#34459
Merged
Conversation
…3917) The original PR diff updated two guides (oauth-over-ssh.md and xai-grok-oauth.md) but only the oauth-over-ssh.md edit landed in the PR's actual commit. Mirror the note to the primary xai-grok-oauth.md guide too so users reading the main entry point don't miss the bare-code form that already shipped in #33880.
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
3 participants
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.
Summary
Tiny docs catch-up — the existing user-facing guides for
--manual-pastementioned the full URL and the bare?code=...&state=...query string forms but didn't mention the third form (bare code, no state) that #33880 shipped in_parse_pasted_callback. xAI's current browser-based-console flow (Cloud Shell, Codespaces, EC2 Instance Connect, Gitpod) renders the auth code in-page instead of redirecting, so users on those surfaces need the bare-code form and were getting stale instructions.Salvages PR #33917 (@r266-tech).
Salvage detail
@r266-tech's PR body described updates to two files (
oauth-over-ssh.mdandxai-grok-oauth.md), but the actual commit on the branch only modifiedoauth-over-ssh.md. The salvage adds the matching paragraph toxai-grok-oauth.mdso users reading the primary entry point don't miss it.Changes
website/docs/guides/oauth-over-ssh.md— @r266-tech's original edit (cherry-picked verbatim): expanded the one-liner about manual-paste forms to mention all three (full URL, bare query string, bare code).website/docs/guides/xai-grok-oauth.md— follow-up: add the bare-code paragraph after the existing--manual-pastewalkthrough.Validation
Pure docs, no tests. The in-CLI prompt (
hermes_cli/auth.py_parse_pasted_callbackdocstring at L3118-3133) already documents the three accepted forms, so docs now match runtime behavior.Credit
@r266-tech — caught a real documentation gap. The bare-code form is the load-bearing case for browser-only-console users today (the only path that works against current xAI consent-page behavior), and missing it from the docs left a discoverability hole.