Runway
HomeComponentsPricingDev Tools

Start Here

  • Overview
  • Installation
  • Project Structure

Customize

  • Customization
  • Runtime Configuration
  • Site Content

Build

  • Components
  • Layout
  • Brand

Product Systems

  • Auth, Billing, Email, SEO, Security
Loading docs page
Built withRunway
  1. Dev Tools

Dev Tools

Contributor checks and debugging notes for docs, navigation, and public-site work.

Verification workflow

For docs shell, navigation, and MDX changes, the baseline verification steps are:

bash
1npm run lint
2npm run build

If you touched shared primitives or formatting-sensitive files, also run:

bash
1npm run format:check
2npm run check:ui-architecture

Docs-specific checks

If you touched navigation, routing, search, or right-rail behavior, also confirm:

  1. The intended pages appear in the sidebar and utility-only pages stay out of the main docs nav.
  2. Hidden pages stay out of search.
  3. Search results resolve to real routes.
  4. The active item in On This Page tracks the section currently in view.
  5. The breadcrumbs and related links point at existing pages.

Related

  • Installation
  • Layout

On This Page

  • Verification workflow
  • Docs-specific checks

Related

  • Installation
  • Layout