Skip to content

docs(cli): remove orphaned conversations stub, repoint its links - #423

Merged
hongyi-chen merged 1 commit into
hyc/launch-clifrom
fix/cli-conversations-stub
Jul 31, 2026
Merged

docs(cli): remove orphaned conversations stub, repoint its links#423
hongyi-chen merged 1 commit into
hyc/launch-clifrom
fix/cli-conversations-stub

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Problem

PR #397 (hyc/launch-cli-cli-conversations) was closed unmerged when #399 absorbed its content into cli/agent-conversations.mdx — but the stub it was meant to fill survived on hyc/launch-cli.

The result is a nav entry that leads nowhere useful. src/sidebar.ts listed both, four lines apart, under Using the agent:

{ slug: 'cli/agent-conversations', label: 'Agent conversations' },
...
{ slug: 'cli/conversations', label: 'Managing conversations' },   // <- TODO stub

Clicking Managing conversations lands on a page reading "The Warp Agent CLI documentation for this page is in progress." Four links from already-merged sibling pages route readers there too.

Changes

  • Delete src/content/docs/cli/conversations.mdx.
  • Drop its src/sidebar.ts entry.
  • Repoint the four inbound links to anchors on the real page:
    • cloud-and-orchestration.mdx x2 → /cli/agent-conversations/#managing-conversations
    • reference.mdx/cli/agent-conversations/#managing-conversations
    • reference.mdx (troubleshooting) → /cli/agent-conversations/#conversation-history

No content is lost — everything the stub was scoped to cover (persistence, /new, /conversations, /compact, --resume) already shipped in #399 under Managing conversations on cli/agent-conversations.

No redirect needed

/cli/conversations has never been published: it 404s on docs.warp.dev today, and src/content/docs/cli/ doesn't exist on main. The whole cli/ section goes live for the first time when hyc/launch-cli merges.

Verification

Conversation: https://staging.warp.dev/conversation/39ee73d4-506d-4b4d-a0d0-3b9ed391ba21

Run: https://oz.staging.warp.dev/runs/019fb436-6cbe-7cf3-b4db-9360546f9668

This PR was generated with Oz.

PR #397 (hyc/launch-cli-cli-conversations) was closed unmerged when #399
absorbed its content into cli/agent-conversations.mdx, but the stub it was
meant to fill survived on the launch branch. The sidebar listed it as
"Managing conversations" four lines below the real "Agent conversations"
page, so the launch would have shipped a nav entry leading to a page that
reads "documentation for this page is in progress".

- Delete src/content/docs/cli/conversations.mdx.
- Drop its sidebar entry in src/sidebar.ts.
- Repoint the four inbound links from cloud-and-orchestration.mdx and
  reference.mdx to the corresponding anchors on cli/agent-conversations.

No redirect needed: /cli/conversations has never been published (404 live,
and src/content/docs/cli/ does not exist on main).

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Jul 30, 2026
@vercel

vercel Bot commented Jul 30, 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 Jul 30, 2026 11:12pm

Request Review

Copy link
Copy Markdown
Collaborator Author

Reviewed against the current integration branch: all four /cli/conversations/ references are repointed (nice touch using the more precise #conversation-history anchor for the resume-failure step), both target anchors exist on agent-conversations, the sidebar entry is removed, and no redirect is needed since /cli/ has never shipped to main. Build + internal link check pass with this applied. LGTM.

Heads-up: #398 and #406 still introduce new /cli/conversations/ links (flagged on those PRs), so whichever merges after this one needs the same repoint. #425 applies this same treatment to the troubleshooting stub.

@hongyi-chen
hongyi-chen marked this pull request as ready for review July 31, 2026 03:58
@hongyi-chen
hongyi-chen merged commit ea87e8c into hyc/launch-cli Jul 31, 2026
4 checks passed
@hongyi-chen
hongyi-chen deleted the fix/cli-conversations-stub branch July 31, 2026 03:58
@oz-for-oss

oz-for-oss Bot commented Jul 31, 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

hongyi-chen added a commit that referenced this pull request Jul 31, 2026
PR #405 consolidated troubleshooting into cli/reference.mdx (its
Troubleshooting section) and reset cli/troubleshooting.mdx back to the
skeleton stub, leaving the stub published in the sidebar with no
sub-PR left to fill it. Remove the stub and its sidebar entry, matching
the treatment #423 gives the conversations stub.

No inbound links exist to /cli/troubleshooting/ (checked all merged and
open cli sub-PR content), so no repoints are needed. Advances the
'delete 4 orphaned stubs' item on the #411 integration checklist.

Validation: npm run build green; internal link check 0 broken.

Co-authored-by: Oz <oz-agent@warp.dev>

@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 removes the unpublished /cli/conversations/ stub page, drops its sidebar entry, and repoints the existing inbound CLI docs links to the consolidated agent conversations page anchors.

Concerns

  • No blocking concerns found. The attached spec context contains no approved or repository spec requirements to compare against, and the diff does not introduce security-relevant code or configuration changes.

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

hongyi-chen added a commit that referenced this pull request Aug 4, 2026
* Add Warp CLI launch docs skeleton and internal plan

- New 'Warp CLI' sidebar topic with 13 stub pages under src/content/docs/cli/
- drafts/warp-cli-launch-plan.md: internal feature->page->reviewer analysis
- New WARP_CLI content var (distinct from WARP_AGENT_CLI, reserved for the
  Oz CLI rename)

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

* Rename product to Warp Agent CLI

- WARP_CLI var value -> "Warp Agent CLI" (body prose updates site-wide)
- Sidebar topic label updated
- Frontmatter literals fixed in the four stubs pending deletion
- drafts doc: naming confirmed; WARP_AGENT_CLI key collision flagged

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

* docs(cli): models and usage + reference with troubleshooting (#405)

* docs(cli): draft reference, models & usage, and troubleshooting pages

Fill in the three cli-reference pages from the Warp CLI launch skeleton:

- cli/reference: command-line flags with examples, environment variables,
  full slash-command table (25 commands verified against the CLI command
  registry), and default keyboard shortcuts sourced from the CLI keybinding
  definitions.
- cli/models-and-usage: /model picker and footer model entry, BYOK via
  /add-api-key + provider flags (OpenAI/Anthropic/Google), custom model
  routers in the picker, and cost transparency (footer credits toggle,
  /cost per-response summary).
- cli/troubleshooting: /view-logs bundling and log locations, login
  troubleshooting, autoupdate behavior with /version and --version, and
  support links.

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

* docs(cli): use literal Warp CLI in frontmatter title/description

Frontmatter {{WARP_CLI}} tokens are not substituted by the build (Astro's
content layer parses frontmatter outside Vite), so built titles showed the
raw token. Body prose keeps {VARS.WARP_CLI}.

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

* docs(cli): fold troubleshooting into the reference page

Consolidation: the standalone troubleshooting page merges into
cli/reference.mdx as a final Troubleshooting section with problem-oriented
H3 subsections. Existing H2 anchors (#slash-commands, #keyboard-shortcuts)
are unchanged; internal links now point at #updating and
#command-line-flags. troubleshooting.mdx is restored to the base-branch
stub (the orchestrator removes it at integration).

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

* docs(cli): rename literal Warp CLI to Warp Agent CLI in frontmatter

Follows the base-branch WARP_CLI var value change; body prose picks up the
new name automatically via {VARS.WARP_CLI}.

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

* docs(cli): security fixes for API key examples

Address review feedback:
- Make WARP_API_KEY=... warp the primary non-interactive auth example and
  document --api-key secondarily with a caution that command-line arguments
  can be captured in shell history and process listings.
- Replace the persistent key.txt stdin example with a tool-agnostic
  secret-manager pipe and a note against staging keys in plaintext files.

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

* docs(cli): editorial polish pass

Reduce product-name density after each page's intro (prefer "the CLI"),
vary repeated trailing "See [X]" sentences, and fold two cross-links into
their sentences. No structural, factual, heading, or link-target changes.

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

* docs(cli): trim menu-mechanics narration

Cut the type-to-filter/arrows/Enter sentence from the model picker prose
and the keep-typing-to-filter clause from the slash-command intro, per the
editorial bar against narrating self-evident UI mechanics. Defaults,
exceptions, and lookup tables are unchanged.

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

* docs(cli): note macOS Option-as-Alt requirement for Alt shortcuts

Platform audit: every keybinding registration is identical on macOS and
Linux (the only platform-conditional binding is a Windows-only Alt+V
paste, which is not documented since no Windows build ships). Input
arrives as terminal key events, so Alt shortcuts depend on the host
terminal delivering Option as Alt on macOS; add one note to the keyboard
shortcuts section instead of per-row annotations.

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

* docs(cli): tighten disabled-models sentence in model picker prose

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

* docs(cli): update API key docs for /api-keys menu and --auto-approve flag

Address review feedback on the API key flow change (warpdotdev/warp#14472),
which replaced /add-api-key and /clear-provider-api-key with a single inline
/api-keys menu:

- models-and-usage: rewrite the BYOK section around the /api-keys menu —
  set/replace/clear provider keys with masked entry, connect or disconnect
  X Premium/SuperGrok via browser sign-in, and toggle Warp credit fallback.
  The --set-provider-api-key/--clear-provider-api-key flags stay documented
  for scripting (they remain supported per the CODE-1930 spec).
- reference: swap the /add-api-key and /clear-provider-api-key slash-command
  rows for /api-keys, and point --set-provider-api-key at the in-session menu.
- reference: document the new --auto-approve flag (warpdotdev/warp#14483),
  which starts new conversations in that launch with auto-approve enabled.

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

* docs(cli): editorial trim pass on API key and auto-approve additions

Remove redundant clauses: drop the repeated launch-default sentence in
--auto-approve, the doubled keys-over-credits statement in the fallback
bullet, the repeated browser-sign-in rationale in the scripting paragraph,
and tighten the /api-keys table row to match the terse row pattern.

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

---------

Co-authored-by: Oz <oz-agent@warp.dev>

* docs(cli): permissions and profiles (#404)

Replaces the `cli/permissions-and-profiles.mdx` stub with a full draft covering the permission model, permission cards, auto-approve, and settings-file execution profiles.

Verified against `warp` master:
- Per-action-type permission values and CLI defaults (`AIExecutionProfile::default_profile_for_tui`)
- `warp --auto-approve` launch flag (warpdotdev/warp#14483)
- `auto_approve_bypasses_command_denylist` defaults to true, so auto-approve bypasses the user command denylist; team-enforced Admin Panel rules are never bypassed (`can_autoexecute_command`)

Follow-ups tracked, not included here:
- `--auto-approve` needs adding to the flags table on `cli/reference.mdx` (separate stub PR on this stack)
- `agent-platform/capabilities/agent-profiles-permissions.mdx` has two now-stale denylist statements given the new bypass default

Reviewed by @harryalbert.

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

* docs(cli): cloud handoff and orchestration (#402)

Replaces the cli/cloud-and-orchestration stub with the full draft: /handoff flow and guardrails, resuming cloud runs (browser-first), multi-agent orchestration approval card and permission, child-agent tab bar management, and Ctrl+C kill paths. Includes review feedback from harryalbert and a final editorial pass.

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

* docs(cli): agent conversations and conversation management (#399)

* docs(cli): draft agent conversations page

Covers the streaming transcript, Markdown/Mermaid rendering, tool-call
rows, file-edit diffs, thinking blocks, interactive agent questions,
task lists, /plan flow, and transcript selection/copy for the Warp CLI.

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

* docs(cli): use literal Warp CLI in frontmatter

{{WARP_CLI}} tokens are not substituted in MDX frontmatter by the
content layer, so built titles/descriptions showed the raw token.
Body prose keeps {VARS.WARP_CLI}.

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

* docs(cli): absorb conversation management into agent conversations page

Adds a Managing conversations section group (persistence/restore,
/new /agent /clear, /conversations menu + left-arrow shortcut,
/compact, exit summary + --resume) from the standalone conversations
page, which is being removed in the consolidation. Updates the intro,
description, and related pages accordingly.

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

* docs(cli): rename to Warp Agent CLI in frontmatter

Follows the launch-name change; body prose picks up the new name via
the WARP_CLI var from the base branch merge.

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

* docs(cli): editorial polish on agent conversations page

Reduces product-name repetition after the intro, links bold lead terms
in the tool-call list instead of trailing See-X sentences, swaps
'unfolds' for 'appears', fixes 'just', and de-metas the intro's
managing-conversations pointer. No factual, heading, or link-target
changes.

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

* docs(cli): trim self-evident UI narration per review

Per PR review: cut transcript scrolling narration, collapse the
markdown-features list to its non-obvious caveats (folding the H3),
drop the tool-call glyph state-machine detail, and sweep the rest of
the page with the same lens (menu how-tos, click-to-collapse, and
double/triple-click narration removed). Feature facts, caveats,
shortcuts, and cross-links are unchanged.

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

* docs(cli): apply editorial audit cuts

Seven targeted trims: intro filler sentence, diff-header bullet detail,
multi-question tail, bold header adjective, copy-confirmation footer
mention, managing-conversations enumeration, and history restore
phrasing.

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

* docs(cli): address review feedback on agent conversations

- Trim styling narration from the transcript intro (prompt row marker,
  elapsed-time progress indicator) that would go stale with small UI
  changes; keep the durable behavior (streaming, Ctrl+C to stop).
- Color the task-list status glyphs to match the TUI: yellow in-progress
  dot and green completed check, via mode-aware Starlight hue tokens so
  they stay legible in dark and light mode.
- Lead "Resuming conversations" with the conversation menu, the primary
  way to resume in the CLI, and note type-to-filter in the menu.

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

* docs(cli): editorial pass for redundancy and flow

- Collapse three separate "restores the full transcript" statements into
  one, in Conversation persistence, where the detail belongs.
- Replace the duplicated "saved automatically" claim with the account vs.
  local-machine distinction, which sets up the menu contents and the
  offline caution that follow.
- Move Resuming conversations next to Conversation history so the two
  cross-referencing sections are adjacent instead of split by Compacting
  context.
- Point the intro's resume link at #resuming-conversations directly, and
  fix a dangling modifier in the tool-call description.

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

---------

Co-authored-by: Oz <oz-agent@warp.dev>

* docs(cli): remove orphaned conversations stub, repoint its links (#423)

PR #397 (hyc/launch-cli-cli-conversations) was closed unmerged when #399
absorbed its content into cli/agent-conversations.mdx, but the stub it was
meant to fill survived on the launch branch. The sidebar listed it as
"Managing conversations" four lines below the real "Agent conversations"
page, so the launch would have shipped a nav entry leading to a page that
reads "documentation for this page is in progress".

- Delete src/content/docs/cli/conversations.mdx.
- Drop its sidebar entry in src/sidebar.ts.
- Repoint the four inbound links from cloud-and-orchestration.mdx and
  reference.mdx to the corresponding anchors on cli/agent-conversations.

No redirect needed: /cli/conversations has never been published (404 live,
and src/content/docs/cli/ does not exist on main).

Co-authored-by: Oz <oz-agent@warp.dev>

* docs(cli): remove orphaned troubleshooting stub (#425)

PR #405 consolidated troubleshooting into cli/reference.mdx (its
Troubleshooting section) and reset cli/troubleshooting.mdx back to the
skeleton stub, leaving the stub published in the sidebar with no
sub-PR left to fill it. Remove the stub and its sidebar entry, matching
the treatment #423 gives the conversations stub.

No inbound links exist to /cli/troubleshooting/ (checked all merged and
open cli sub-PR content), so no repoints are needed. Advances the
'delete 4 orphaned stubs' item on the #411 integration checklist.

Validation: npm run build green; internal link check 0 broken.

Co-authored-by: Oz <oz-agent@warp.dev>

* docs(cli): customization (settings, themes, statusline, rules, skills, MCP) (#401)

* docs(cli): draft the Warp CLI configuration page

Cover the local TOML settings file (per-platform locations, hot reload,
error fallback, local-only/no cloud sync), editing settings by asking the
agent, /theme with terminal background detection, and the statusline with
/statusline customization. Drop the keybindings section: custom keybinding
overrides are not loaded by the CLI yet.

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

* docs(cli): use literal Warp CLI in configuration frontmatter

{{WARP_CLI}} tokens are not substituted in MDX frontmatter by the build
pipeline, so the built title/description showed the raw token. Body prose
keeps {VARS.WARP_CLI}.

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

* docs(cli): absorb agent context content into the customization page

Consolidate the CLI docs: fold the context page's rules, skills, bundled
skills, and MCP sections into configuration.mdx, retitled "Customizing the
Warp CLI". Dedupe the modify-settings bundled skill treatment and switch
cross-links to in-page anchors. The context.mdx file itself is removed at
integration.

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

* docs(cli): rename Warp CLI to Warp Agent CLI in customization frontmatter

Follows the site-wide WARP_CLI var update on the base branch; body prose
picks up the new name via the var automatically.

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

* docs(cli): qualify settings hot reload for theme edits

Address review on PR #401: settings values hot-reload from disk, but the
rendered theme only re-applies via /theme or at the next startup, so the
settings-file and agent-edit sections no longer promise immediate effect
for theme changes. Also scope the Themes section's immediate-apply claim
to /theme. Windows path verified to render with single backslashes in
source and built HTML; no change needed.

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

* docs(cli): reduce product-name density on the customization page

Editorial polish pass: after the intro's first mention, refer to the
product as "the CLI" instead of repeating the full name in every section.
The full name stays in the frontmatter, the intro, and the reference link.
No structural, factual, heading, or link-target changes.

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

* docs(cli): trim obvious menu-mechanics narration

Per editorial direction: collapse the skills-menu step list into the
non-obvious behaviors (selection inserts /skill-name for editing, argument
passing, direct invocation) and drop the arrow-select narration in the
/mcp view. Keep the statusline config steps since its keys are surprising
(Esc saves, arrows reorder). No headings, facts, or link targets changed.

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

* docs(cli): compress statusline catalog and tighten context and /mcp prose

Apply orchestrator audit: keep only statusline items with non-obvious
behavior as bullets and fold the self-explanatory ones into one sentence,
shorten the working-directory context paragraph, and replace the four
per-state /mcp bullets with two lines.

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

* docs(cli): re-verify statusline items against latest master

Master's statusline catalog changed (moira's #14257/#14458): the
auto-queue item was removed, and Vim mode indicator and GitHub pull
request items were added. Auto-approve and Vim mode indicator are now on
by default. Update the item list, defaults, and the auto-approve and git
diff descriptions accordingly. Themes, settings paths, and the /statusline
config flow re-verified against master and unchanged.

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

---------

Co-authored-by: Oz <oz-agent@warp.dev>

* Post-merge coherence pass on cli docs

- Remove orphaned context stub (content lives in configuration.mdx via #401)
  and its sidebar entry; repoint the reference page link
- Fix stale auto-approve statusline claim in permissions page (the indicator
  is default-on since the statusline catalog update)

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

* docs: address review feedback on agent-conversations.mdx

Applies suggested edits and resolves open questions from PR review:
- Applies wording/phrasing suggestions from inline suggestion comments
- Reworks the tool-call and code-diff bullet lists for consistent
  bold-term + dash + description formatting
- Clarifies multi-file diff nesting based on TuiFileEditsView source
- Clarifies the plan toggle shortcut per the CLI reference page
  (Ctrl+Shift+P expands/collapses the latest plan)
- Reorders the copy/export paragraph before the clipboard note
- Simplifies the /new, /agent, /clear list since the intro sentence
  already explains their behavior
- Formats YOUR_CONVERSATION_TOKEN as inline code

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

* docs: address review feedback on cloud-and-orchestration.mdx

Applies suggested edits and resolves open questions from PR review:
- Applies wording/phrasing suggestions from inline suggestion comments
- Rewords the intro to avoid the ambiguous "Oz Platform" phrase pending
  a vars.ts decision
- Reworks the handoff steps and card-action bullets for consistent
  bold-term + dash + description formatting; moves the pre-confirm
  Ctrl+C cancel note to its correct chronological position
- Clarifies the handoff card's model-preselection wording
- Restructures 'Resume cloud conversations' into a clear two-option
  (browser / CLI) + constraints layout
- Splits the dense orchestration-start paragraph and the tab-bar
  navigation bullet for scannability
- Clarifies 'read-only status views' wording for cloud child sessions
- Fixes non-em-dash usage flagged in the kill-agent paragraph
- Adds a real screenshot of the Agents: tab bar, captured liv- Adds a real screenshot of the Agents: tab bar, captured liv- Adds a real screenshot of the Agents: tab bar, captured liv- Adds  in warpdotdev/warp

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

* docs: address review feedback on models-and-usage.mdx

- Applies suggestion comments: intro rewording, model-picker/profile
  wording, semicolon and colon cleanup, usage bullet rewording
- Clarifies the ambiguous "footer" reference by naming and linking to
  the statusline section in configuration.mdx (applied consistently to
  both occurrences on the page)

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

* docs: fix statusline default-items accuracy and add screenshot

Verified against warpdotdev/warp origin/master (crates/warp_tui/src/
terminal_session_view/statusline.rs, app/src/settings/ai.rs):
- Adds the missing 'Working directory' bullet; it's a default item,
  not one you 'also add'
- Clarifies that enabling Git branch status replaces the plain Git
  branch chip rather than adding a second one
  (should_render_plain_git_branch requires branch status disabled)
- Adds a real screenshot of the statusline with credit usage, context
  window usage, and task-list chips enabled, captured live via the
  tui-verify-change skill in warpdotdev/warp

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

* docs: address review feedback on permissions-and-profiles.mdx and reference.mdx

permissions-and-profiles.mdx:
- Applies suggestion comments: description/intro trims, colon removal
- Clarifies the vague "letting file reads through" example
- Converts the dense default-permissions paragraph into a scannable
  bulleted list
- Removes semicolons from the approval-card bullets and tightens
  wording
- Links the settings-file bypass instructions to configuration.mdx

reference.mdx:
- Applies the intro suggestion, removing the mid-sentence colon

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

* docs: holistic style pass across Warp Agent CLI docs

Applies the same rubric from earlier review rounds (unclear language,
wordy passages, unnecessary UI detail, colons/semicolons) to the rest
of the PR:

- reference.mdx: fixes a grammar issue in the flags intro, removes
  mid-sentence colons/semicolons in the slash commands, keyboard
  shortcuts, and troubleshooting sections (only line 9 had been
  reviewed directly)
- Re-scanned all previously-edited files (agent-conversations,
  cloud-and-orchestration, configuration, models-and-usage) for
  remaining semicolons joining independent clauses and split them
  into separate sentences for consistency

index.mdx, quickstart.mdx, input-and-editing.mdx, and shell-commands.mdx
are still TODO-only placeholder stubs (no drafted prose yet), so there
was nothing to style-review there.

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

* docs: crop and highlight the CLI screenshots for clarity

Both screenshots previously showed the full 120x40 terminal window,
making it unclear which part was the actual subject. Cropped each to
the relevant region and added a highlighted border around the exact
row being documented:
- tui-agents-tab-bar.png: cropped to the top strip (bar + one line of
  context below); highlighted the Agents: tab bar row
- tui-statusline.png: cropped to the bottom strip (last transcript
  line, input box, statusline); highlighted the statusline row

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

* docs(cli): overview and quickstart (#398)

* docs(cli): draft Warp CLI overview and quickstart pages

Fill in cli/index.mdx (what the CLI is, key features, relationship to the
Warp app and Oz, supported platforms, login/logout, automatic updates,
migration from the Warp app, open source) and cli/quickstart.mdx
(install placeholder, device-auth login, first prompt, shell command,
exit and resume).

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

* docs(cli): use literal Warp CLI in frontmatter titles and descriptions

Frontmatter {{WARP_CLI}} tokens are not substituted by the build
pipeline, so built titles showed the raw token. Body prose keeps
{VARS.WARP_CLI}.

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

* docs(cli): rename to Warp Agent CLI in frontmatter and intro

Update literal frontmatter titles/descriptions for the confirmed launch
name and rework the overview intro now that Warp Agent CLI is the
primary name (positioning: the Warp Agent from the Warp app, in any
terminal). Body {VARS.WARP_CLI} usages pick up the new name from the
merged var change.

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

* docs(cli): address PR #398 review comments

Add a visible interim note to the quickstart install section so it no
longer renders empty alongside the pending-instructions comment, and
make the WARP_API_KEY environment variable the primary non-interactive
auth recommendation with a caution about --api-key appearing in shell
history and process listings.

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

* docs(cli): editorial polish on overview and quickstart

Link the bold feature names in the overview's key features list and
drop the trailing See-X sentences, prefer "the CLI" over the full
product name after first mention, and fold the trailing conversations
link in the quickstart into its sentence.

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

* docs(cli): address owner review on overview page

Remove named third-party terminals from the intro, reference the
platform name through the content variable in body prose (heading and
frontmatter keep the literal name), and drop the Open source section.

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

* docs(cli): trim narration of obvious mechanics from quickstart

Cut the section-enumerating intro sentence, the press-Enter and
output-appears step narration, and the placeholder restatement in the
resume step. Overview page needed no cuts.

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

* docs(cli): correct Warp Drive claim to saved prompts only

Verified against the Warp repo: the CLI's slash menu wires only the
saved-prompts data source (plus static commands and skills); workflows,
notebooks, and environment variables have no CLI surface.

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

* docs(cli): repoint links after context and conversations pages merged

The context and conversations pages were consolidated on the base
branch. Point the overview and quickstart links at their new homes:
project context -> configuration#project-context-and-rules, and
persistence/history -> agent-conversations sections. Merge the
duplicate quickstart next-step into a single Configuration bullet.

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

* docs(cli): update overview and installation

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

* docs(cli): clarify zero-state customization

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

* docs(cli): fix renamed agent docs links

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

---------

Co-authored-by: Oz <oz-agent@warp.dev>
Co-authored-by: Yunfan Yang <kevin@warp.dev>

* docs(cli): input and shell commands (#406)

* docs(cli): draft input and editing page

Replace the cli/input-and-editing.mdx stub with full content covering
editing basics, the slash command menu with argument hints, up-arrow
prompt history, shell tab completions, mouse support, selection and
clipboard behavior (incl. OSC 52 over SSH), image attachments, voice
input, and the contextual keyboard hints plus the ? shortcuts menu.

Dropped from the outline after verifying against warp master: Vim mode
(not merged), inline-menu mouse clicks (not shipped), and configurable
keybinding claims (the CLI does not load keybinding overrides yet).

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

* docs(cli): use literal Warp CLI in frontmatter

{{WARP_CLI}} tokens are not substituted in MDX frontmatter (Astro's
content layer parses frontmatter outside Vite), so the built title and
description showed the raw token. Body-prose {VARS.WARP_CLI} is
unchanged. Verified the built dist/cli/input-and-editing <title> now
reads "Input and editing in the Warp CLI".

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

* docs(cli): absorb shell commands page into input page

Consolidation: merge the verified content of cli/shell-commands.mdx
(PR #403, branch hyc/launch-cli-cli-shell-commands) into
cli/input-and-editing.mdx as a single "Input and shell commands in the
Warp CLI" page. Adds shell mode, natural language detection,
long-running and interactive commands, full-screen apps, and stopping/
exiting sections; merges the two history sections into one (adopting
the verified submit-on-Enter semantics); rewires shell-mode links to
in-page anchors. File rename to the new slug happens at integration.

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

* docs(cli): rename Warp CLI to Warp Agent CLI in frontmatter

Launch name confirmed as Warp Agent CLI. Base branch merge picks up the
WARP_CLI var change (e2aebe3) for body prose; this updates the two
literal frontmatter strings (title, description). Verified the built
title reads "Input and shell commands in the Warp Agent CLI".

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

* docs(cli): light editorial polish on input page

Reduce product-name density (prefer "the CLI" after the intro; keep the
full name in the intro and Related pages), drop one banned word
("just"), remove a filler wayfinding sentence from the intro, vary a
repeated cross-reference rhythm, dedupe "lands in the input", and use a
plainer verb for the hints section opener. No heading, fact, or link
target changes.

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

* docs(cli): trim narration of obvious UI mechanics

Per editorial direction: cut the slash-menu usage steps, the Submit and
six-row-scroll narration in editing basics, the history Filter bullet,
completion-menu Enter/Esc narration, cursor-click and scroll-wheel
bullets, the attachment-bar arrow/Enter steps (kept Tab focus,
Backspace remove, Esc return as one sentence), the "Speak your prompt"
voice step, the duplicated long-running interrupt hint, type-and-press-
Enter in shell mode, and the output-streams-in sentence. Kept
non-obvious keys, defaults, and gotchas (submit-on-Enter history
semantics, restore-on-dismiss, OSC 52 note). No heading changes.

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

* docs(cli): address review comments on NLD and interrupt hint

Rename the natural-language-detection bullet lead from "Biased toward
the agent" to "Ambiguous input" so it states the behavior without
characterizing the classifier, and drop the interrupt-hint bullet from
long-running commands (Ctrl+C interrupt is already covered in Stopping
commands and exiting).

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

* docs(cli): apply orchestrator editorial audit

Shorten the editing-basics intro, add the verified macOS/Linux Alt
keybinding note, sharpen the history Submit/Dismiss bullets and drop
the command-history sentence, fold the click-controls bullet into
Selection and clipboard and remove the Mouse support section (no
inbound #mouse-support links), trim the copied-to-clipboard footer
narration, generalize the placeholder-hints bullet, simplify shell-mode
step 2, and remove the transcript-styling sentence.

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

* docs(cli): repoint links to removed context and conversations pages

The base branch merged context.mdx into configuration.mdx and folded
the conversations page into agent-conversations.mdx. Repoint the skills
link to /cli/configuration/#skills, and the two Managing conversations
links to /cli/agent-conversations/#managing-conversations (verified both
anchors exist in the merged base). Related pages now lists a single
agent-conversations entry.

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

* docs(cli): clarify keyboard and voice support

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

* docs(cli): clarify Linux voice packaging

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

* docs(cli): fix renamed agent docs links

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

---------

Co-authored-by: Oz <oz-agent@warp.dev>
Co-authored-by: Yunfan Yang <kevin@warp.dev>

* docs(cli): final holistic pass before launch

- Remove the leftover shell-commands stub; its content ships in the combined
  input page, now at cli/input-and-shell-commands (slug matches the title).
  Repoint all inbound links and update the sidebar entry.
- Document start-screen customization (appearance.zero_state: object/ASCII
  art, rotation period, section toggles) on the customization page, and trim
  the overview's Key features bullet to match; keys verified in warp master.
- Remove keybinding-customization claims (loading keybindings.yaml overrides
  in the CLI is still a follow-up per crates/warp_tui/src/keybindings.rs).
- Cover Windows in the reference's platform bindings note (incl. the
  Windows-only Alt+V paste alias).
- Apply the established style rubric (no semicolon-joined clauses or
  mid-sentence colon narration) to the three pages that merged after the
  style pass, plus two stragglers in the reference.
- Dedupe the quickstart's natural-language-detection explanation and fix an
  'Agent Mode' capitalization.
- Add a Warp Agent CLI llms.txt custom set; delete the internal
  drafts/warp-cli-launch-plan.md planning doc so it doesn't ship to main.

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

* docs: keep local pricing drafts out of the launch branch

Untracked local drafts were swept into the previous commit by git add -A;
remove them from tracking (files remain on disk).

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

* docs(cli): fix TOC-visible VARS tokens in headings, shorten nav label

Starlight's on-this-page TOC renders heading text without evaluating MDX
expressions, so two headings showed a literal VARS.WARP_CLI token. Use the
literal product name in headings. Also shorten the top-nav topic label from
'Warp Agent CLI' to 'Agent CLI'.

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

* docs(cli): use right-caret prompt chevron for the Agent CLI nav icon

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

---------

Co-authored-by: Oz <oz-agent@warp.dev>
Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com>
Co-authored-by: Yunfan Yang <kevin@warp.dev>
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