Skip to content

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

Open
rachaelrenk wants to merge 1 commit intomainfrom
docs/nav-label-audit
Open

docs: restore sidebar nav labels and fix sentence case (94 pages)#11
rachaelrenk wants to merge 1 commit intomainfrom
docs/nav-label-audit

Conversation

@rachaelrenk
Copy link
Copy Markdown

Summary

Audit and restore sidebar nav labels that were lost during the GitBook → Astro Starlight migration. During the migration, 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.

This PR adds sidebar.label frontmatter to 94 pages to restore the intended navigation labels and fix sentence case per the style guide.

Changes

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 (falling back from the title) used title case instead of sentence case:

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

Fixed sentence case on existing guide sidebar.labels

12 guide pages that already had sidebar.label but used incorrect casing:

  • "Configure YOLO and Strategic Agent Profiles" → Configure YOLO and strategic Agent Profiles
  • "Figma Remote MCP: Create a website..." → Figma remote MCP: create a website...

What's NOT changed

  • H1 titles — left unchanged (separate work tracked in audit-report.txt)
  • sidebar.ts structural overrides (Overview, Oz CLI, etc.) — untouched
  • Error code pages in /reference/api-and-sdk/troubleshooting/errors/ — intentionally lowercase

How it was done

  1. Built an audit script (scripts/audit-nav-labels.py) that compares GitBook SUMMARY.md labels against Astro frontmatter
  2. Generated a report, human-reviewed and corrected the suggestions
  3. Applied via scripts/apply-nav-labels.py which parses the curated report
  4. Validated with npm run build (308 pages, zero errors)

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 1, 2026 6:11pm

Request Review

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