Skip to content

Commit 4f53585

Browse files
docs: restore sidebar nav labels and fix sentence case (94 pages) (#11)
* docs: add sidebar nav labels and fix sentence case across 94 pages Audit and restore sidebar nav labels that were lost during the GitBook to Astro Starlight migration. Adds sidebar.label frontmatter to 94 pages: - Restore shortened nav labels from GitBook SUMMARY.md (e.g., 'Warp Drive Notebooks' shows as 'Notebooks' in sidebar, 'Terminal Block Basics' shows as 'Block basics') - Fix sentence case on nav labels per style guide (e.g., 'Block Actions' → 'Block actions', 'MCP Servers' → 'MCP servers') - Fix sentence case on existing guide sidebar.labels (12 guide pages) - Leave H1 titles unchanged (separate work) - Leave sidebar.ts structural overrides unchanged Co-Authored-By: Oz <oz-agent@warp.dev> * docs: add 'overview' to H1 titles on section overview pages Standardize overview page titles to consistently include 'overview' in the H1. Also applies sentence case fixes to these titles. 15 pages updated: - Capabilities → Capabilities overview - Self-hosting → Self-hosting overview - Triggers → Triggers overview - Agent Context → Agent context overview - Third-Party CLI Agents → Third-party CLI agents overview - Cloud Agents Overview → Cloud agents overview (sentence case fix) - Terminal appearance/blocks/completions/comparisons/editor/entry/ more-features/sessions/windows → added 'overview' + sentence case Co-Authored-By: Oz <oz-agent@warp.dev> * fix: remove duplicate description line in supported-shells.mdx Co-Authored-By: Oz <oz-agent@warp.dev> * fix: remove case-only sidebar.labels and duplicate description - git-worktrees.mdx: remove sidebar.label 'Git Worktrees' (title 'Git worktrees' is already correct sentence case) - vertical-tabs.mdx: remove sidebar.label 'Vertical Tabs' (title 'Vertical tabs' is already correct) and fix duplicate description line Co-Authored-By: Oz <oz-agent@warp.dev> * docs: add Vertical Tabs and Tab Configs to terminology glossary - Add 'Vertical Tabs' and 'Tab Configs' as official feature names in .warp/references/terminology.md (Navigation and UI terms section) - Capitalize 'Vertical Tabs' in vertical-tabs.mdx title to match - Restore sidebar.label for Vertical Tabs Co-Authored-By: Oz <oz-agent@warp.dev> * docs: fix enterprise quickstart title and nav label - Title: 'Quick start' → 'Enterprise quickstart' (one word per style guide, with descriptive topic name per quickstart rules) - Add sidebar.label: 'Quickstart' for shortened nav display Co-Authored-By: Oz <oz-agent@warp.dev> * docs: standardize 'quickstart' as one word across all docs Fix all instances of 'Quick Start' and 'quick start' to use 'quickstart' (one word, lowercase) per the style guide. Includes: - Cloud agents title: 'Cloud Agents Quick Start' → 'Cloud agents quickstart' - CLI title: 'Quick Start' → 'CLI quickstart' - Section header in command-search.mdx - Body text references in overview, platform, known-issues, integration-setup - Also fixed 'Integrations Overview' → 'Integrations overview' in a link Co-Authored-By: Oz <oz-agent@warp.dev> * chore: remove audit scripts from PR These are local utility scripts, not part of the docs site. Co-Authored-By: Oz <oz-agent@warp.dev> --------- Co-authored-by: Oz <oz-agent@warp.dev>
1 parent cbd0860 commit 4f53585

110 files changed

Lines changed: 210 additions & 42 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.agents/references/terminology.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,12 @@ For the summary of the most critical terms (core features, Oz terms, terms to av
6161
- **Tab** / **Pane** / **Window** — Warp's layout primitives: tabs within windows; panes are splits inside a tab/window.
6262
*Usage note:* Use precisely to avoid confusing layouts.
6363

64+
- **Tab Configs** — Reusable TOML-based tab layout definitions that launch preconfigured terminal sessions.
65+
*Usage note:* Capitalize as a feature name.
66+
67+
- **Vertical Tabs** — The sidebar-based tab management panel that replaces the horizontal tab bar.
68+
*Usage note:* Capitalize as a feature name.
69+
6470
## Agent concepts
6571

6672
- **Ambient Agents** — Oz agents that run automatically in the background on a schedule or trigger, without interactive input.

src/content/docs/agent-platform/capabilities/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Capabilities
2+
title: Capabilities overview
33
description: >-
44
Core capabilities and configuration options that shape how agents behave,
55
what context they have access to, and how they execute tasks.

src/content/docs/agent-platform/cli-agents/overview.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
2-
title: Third-Party CLI Agents
2+
title: Third-party CLI agents overview
33
description: >-
44
Warp provides first-class support for third-party CLI coding agents with a
55
rich input editor, notifications, code review, and more.
6+
sidebar:
7+
label: "Overview"
68
---
79

810
Warp auto-detects supported CLI agents and enhances them with IDE-level features — a rich input editor, agent notifications, inline code review, remote session control, and more. Run your preferred coding agent inside Warp and get a better experience out of the box.

src/content/docs/agent-platform/cloud-agents/deployment-patterns.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Deployment Patterns
33
description: >-
44
Common architectures for deploying cloud agents, including CLI-only,
55
Oz-hosted, and self-hosted execution patterns.
6+
sidebar:
7+
label: "Deployment patterns"
68
---
79

810
Teams adopt cloud agents in a few repeatable ways. This page outlines the most common architectures, what they're good for, and how they fit together.

src/content/docs/agent-platform/cloud-agents/faqs.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Cloud Agent FAQs
33
description: >-
44
Frequently asked questions about cloud agents, including where agents run,
55
how runs work, supported models, security, and common workflows.
6+
sidebar:
7+
label: "Cloud agent FAQs"
68
---
79

810
This page answers common questions about cloud agents, including where they run, how they're configured, and how teams use cloud agents for day-to-day engineering work.

src/content/docs/agent-platform/cloud-agents/integrations/cloud-providers.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: Cloud Providers (Preview)
33
description: >-
44
Connect Oz cloud agents to your AWS and GCP services.
5+
sidebar:
6+
label: "AWS, GCP, and other cloud providers"
57
---
68

79
Oz cloud agents can securely access cloud providers using short-lived OpenID Connect credentials.

src/content/docs/agent-platform/cloud-agents/integrations/demo-issue-triage-bot.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: "Demo: Issue Triage Bot"
33
description: >-
44
A walkthrough demo showing how to trigger a cloud agent from a GitHub Action
55
to automatically triage bug reports and create draft pull requests.
6+
sidebar:
7+
label: "Demo: Issue triage bot"
68
---
79
import VideoEmbed from '@components/VideoEmbed.astro';
810

src/content/docs/agent-platform/cloud-agents/integrations/quickstart-github-actions.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: GitHub Actions quickstart
33
description: >-
44
Set up your first Oz agent in GitHub Actions in ~10 minutes. Run agents as
55
workflow steps to automate code review and issue triage.
6+
sidebar:
7+
label: "Quickstart"
68
---
79

810
Add Oz agents to your GitHub Actions workflows with [`oz-agent-action`](https://github.com/warpdotdev/oz-agent-action). This quickstart walks you through setting up your first GitHub Actions integration: a PR review workflow that automatically analyzes pull requests and posts inline review comments.

src/content/docs/agent-platform/cloud-agents/integrations/quickstart.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Integrations quickstart
33
description: >-
44
Trigger your first Oz agent from Slack in ~15 minutes and get results
55
in-thread.
6+
sidebar:
7+
label: "Quickstart"
68
---
79

810
Oz integrations let you trigger cloud agents directly from the tools your team already uses. This guide walks you through connecting Oz to Slack. Once set up, anyone on your team can tag @Oz in a message or thread to kick off a cloud agent that runs the task and posts results back to the conversation.

src/content/docs/agent-platform/cloud-agents/managing-cloud-agents.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: >-
44
Monitor and manage cloud agent activity across your team with Warp's
55
centralized management view, including filtering, status tracking, and
66
session inspection.
7+
sidebar:
8+
label: "Managing cloud agents"
79
---
810
import VideoEmbed from '@components/VideoEmbed.astro';
911

0 commit comments

Comments
 (0)