Skip to content

docs: document the CLI start screen freeze-animation setting - #479

Open
hongyi-chen wants to merge 2 commits into
mainfrom
docs/cli-start-screen-freeze-animation
Open

docs: document the CLI start screen freeze-animation setting#479
hongyi-chen wants to merge 2 commits into
mainfrom
docs/cli-start-screen-freeze-animation

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Summary

A missing_docs drift-watch run flagged appearance.zero_state.freeze_animation_when_unfocused as a new, undocumented setting. It's a GA (always_on), user-facing Warp Agent CLI setting, so it belongs alongside the other appearance.zero_state knobs on the CLI configuration page.

Source of truth: app/src/settings/tui_zero_state.rs (TuiZeroStateFreezeAnimationWhenUnfocusedSetting, SettingSurfaces::TUI, default false) and crates/warp_tui/src/session.rs, which subscribes to the setting and applies it without a restart.

Changes

src/content/docs/cli/configuration.mdx

  • Added freeze_animation_when_unfocused to the Start screen settings list, noting that it stops repainting while the terminal window is unfocused, that it's off by default, and that changes apply as soon as you save.

The surface-map entry pointing this setting at the CLI configuration page ships in the companion audit-bookkeeping PR.

Validation

  • npm run build passes.
  • check_links.py reports 0 broken links.
  • Re-running the audit no longer reports the setting as undocumented.

Deferred findings from this audit run

Summarized in full in the companion audit-bookkeeping PR:

  • OpenAPI spec drift for three released endpoints — belongs to the sync-openapi-spec skill.
  • 30 low-severity terminology flags, verified as false positives.
  • 81 --weak-coverage findings, spot-checked as heuristic noise.

Co-Authored-By: Oz oz-agent@warp.dev
Co-Authored-By: Warp Agent agent@warp.dev

Document appearance.zero_state.freeze_animation_when_unfocused, which stops
the Warp Agent CLI start screen animation from repainting while the terminal
is unfocused.

Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Warp Agent <agent@warp.dev>
@vercel

vercel Bot commented Aug 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 5, 2026 7:27pm

Request Review

@hongyi-chen
hongyi-chen requested a review from moirahuang August 5, 2026 19:24
@hongyi-chen
hongyi-chen enabled auto-merge (squash) August 5, 2026 19:24
@oz-for-oss

oz-for-oss Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

@hongyi-chen

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@oz-for-oss oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR adds documentation for the appearance.zero_state.freeze_animation_when_unfocused CLI start screen setting, including its behavior, default, and hot-reload behavior.

Concerns

  • No blocking concerns found.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant