Skip to content

docs: restore sidebar nav labels and fix sentence case (94 pages)#11

Merged
rachaelrenk merged 9 commits intomainfrom
docs/nav-label-audit
May 5, 2026
Merged

docs: restore sidebar nav labels and fix sentence case (94 pages)#11
rachaelrenk merged 9 commits intomainfrom
docs/nav-label-audit

Conversation

@rachaelrenk
Copy link
Copy Markdown
Contributor

@rachaelrenk rachaelrenk commented May 1, 2026

Summary

Audit and restore sidebar nav labels that were lost during the GitBook → Astro Starlight migration, and standardize overview page H1 titles.

During the migration, some of GitBook's SUMMARY.md nav labels (often shorter than the page H1) weren't carried over — causing the full H1 title to display in the sidebar instead. Additionally, overview/index pages inconsistently included "overview" in their H1 titles.

Changes

Commit 1: Restore nav labels and fix sentence case (94 pages)

Restored shortened nav labels (from GitBook SUMMARY.md) — pages where the nav label should be shorter than the H1:

  • "Warp Drive Notebooks" → sidebar shows Notebooks
  • "Terminal Block Basics" → sidebar shows Block basics
  • "Input editor Vim keybindings" → sidebar shows Vim keybindings
  • "Terminal themes" → sidebar shows Themes
  • "Cloud Agents Quick Start" → sidebar shows Quickstart
  • And ~30 more pages with similar shortening

Fixed sentence case on nav labels — pages where the nav label used title case instead of sentence case:

  • "Block Actions" → Block actions
  • "MCP Servers" → MCP servers
  • "Command History" → Command history
  • And ~50 more pages

Fixed sentence case on existing guide sidebar.labels — 12 guide pages that already had sidebar.label but used incorrect casing.

Commit 2: Standardize overview page H1 titles (15 pages)

Added "overview" to H1 titles on section overview pages for consistency, with sentence case fixes:

  • "Capabilities" → Capabilities overview
  • "Self-hosting" → Self-hosting overview
  • "Triggers" → Triggers overview
  • "Modern Text Editing" → Modern text editing overview
  • "Cloud Agents Overview" → Cloud agents overview (sentence case fix)
  • And 10 more section overview pages

Commit 3: Fix duplicate description in supported-shells.mdx

Removed a duplicate description line in the frontmatter that was pre-existing.

What's NOT changed

  • sidebar.ts structural overrides (Overview, Oz CLI, etc.) — untouched
  • Error code pages in /reference/api-and-sdk/troubleshooting/errors/ — intentionally lowercase
  • Feature doc pages that aren't true overviews (e.g., "Built-in Code Editor", "Interacting with agents")

Artifacts

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

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>
@cla-bot cla-bot Bot added the cla-signed label May 1, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 1, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 5, 2026 4:01pm

Request Review

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>
- 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>
- 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>
- 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>
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>
These are local utility scripts, not part of the docs site.

Co-Authored-By: Oz <oz-agent@warp.dev>
@rachaelrenk rachaelrenk merged commit 4f53585 into main May 5, 2026
8 checks passed
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.

3 participants