docs: KEEP-1047 regenerate kh auth login reference - #74
Merged
Conversation
The --force flag landed in #73 without a docs regeneration. Regenerating this page also corrects drift that predates it: the synopsis described an OAuth browser default with a --no-browser flag, neither of which exists in cmd/auth/login.go, and the inherited --org flag was missing. Only this page is regenerated. The generator rewrites 68 files and adds 14 missing ones, because docs-check cannot catch drift - its go generate ./docs/ step is a no-op, the //go:generate directive sitting in a //go:build ignore file. Tracked separately.
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.
What
Regenerates
docs/kh_auth_login.md. One file, generated output only.Why
#73 added
--forcewithout regenerating the command reference, somaincurrently documents a login command that does not match the binary. Regenerating
this page also corrects drift that predates that PR:
--no-browserflag that does not exist incmd/auth/login.go. Both theexample block and the flag list referenced it.
--orgflag was missing.Why only one file
The generator rewrites 68 files and adds 14 missing ones on current
main. That backlog exists becausedocs-checkcannot detect drift: itsgo generate ./docs/step is a no-op, since the//go:generatedirective livesin
docs/generate.go, which is marked//go:build ignoreand is therefore neverscanned. The job passes unconditionally in ~16s.
Fixing the guard and regenerating the full tree is tracked separately - it has to
be one change, because fixing the guard alone turns the next unrelated PR red.
This PR deliberately stays scoped to the page #73 made wrong.
Known remaining inaccuracy
The regenerated synopsis still says "Opens a browser to confirm a one-time code."
That is generated verbatim from the command's
Longstring, and it is wrong -internal/auth/device.goonly prints the URL and never opens a browser. Fixingit means editing the help text rather than regenerating, so it is left to the
tracked follow-up alongside the expiry error that suggests running
kh auth login --no-browser.Test plan
cd docs && go run generate.goagainst this branch, nothand-edited
docs-checkwill pass, but note it passes regardless - it cannot fail