Repository navigation
Conversation
…and history Note that the desktop hand-off in `open` is macOS-only for now, that `timeline apply --plan` prints only a count without --json, and what `history undo --who` reverts. Refs heygen-com#5386 Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Preview approval requiredThis pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit |
meghna810
marked this pull request as draft
October 23, 2026 03:33
jrusso1020
approved these changes
Oct 23, 2026
jrusso1020
left a comment
Collaborator
There was a problem hiding this comment.
Checked all three wording changes against main, and each one matches the code:
open:HANDOFF_READY = process.platform === "darwin"(packages/cli/src/utils/desktopApp.ts:29) is the defaultreadyfor both hand-off paths, so off macOS it always falls through to the exit-1 download link.timeline apply --plan: the text-mode summary is justplanned N file(s)(a2Commands.ts:264). The result and diff come with--json.history undo --who:turnTargets(history.ts:247-262) takes the last turn's entries that are still in effect and throws "…last turn has no change still in effect; undo an older entry by its id" rather than falling back. The new "(its newest entry if it never usedbegin)" matches the doc comment at :244-245.
Docs-only, one file, no other changes. LGTM.
— Rames
meghna810
marked this pull request as ready for review
October 23, 2026 05:07
This branch has not been deployed
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
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
Applies the three optional notes @jrusso1020 left on #5442 to the CLI reference (
docs/packages/cli.mdx). #5442 auto-merged before I got to them.Why
Each note corrects something the page states:
open: the desktop hand-off is macOS-only for now (HANDOFF_READY = process.platform === "darwin"inpackages/cli/src/utils/desktopApp.ts), so on Windows and Linuxopenalways exits 1 with the download link. The page didn't say so.timeline apply --plan: in text mode it prints only a count (planned 1 file,a2Commands.ts); the result and diff come with--json. The flag table said every--planprints the result and the diff, which is true of the single verbs only.history undo --who: it undoes what is still in effect from that name's last turn, and refuses (rather than falling back to an older turn) when nothing from that turn is still in effect (turnTargetsinhistory.ts). The table said "that name's newest turn still in effect", which reads like the fallback.Related work
Follow-up to #5442 (review comments) · Refs #5386
How
Three wording changes in
docs/packages/cli.mdx: one sentence after theopen --jsonparagraph, and one cell each in thetimelineflag table and thehistorycommand table. No other files.Test plan
mainand ran them with the CLI built frommainon a freshhyperframes initproject:timeline apply plan.json --planprintsplanned 1 file;--plan --jsonreturnsbefore,afteranddiff, and nothing is written.history undo --who claudewith no entries from that name refuses withclaude has no entry still in effect.open --jsonwithout the app installed exits 1 withreason: "not-installed"and thedownloadUrl(macOS). The Windows/Linux behaviour is from theHANDOFF_READYcheck; I don't have those machines to run it on.node scripts/check-docs-cli-commands.mjs,bun run check:docs-snippet-motionandcheck:studio-copy-dashespass.npx mint broken-links --check-redirectspasses (indocs/, Node 22).mint validatehung locally at "validating build…" without reporting an error, so I'm relying on the docs workflow for it.🤖 Generated with Claude Code