API Preview Rail

Hybrid docs block for a live preview, API contract, and compact implementation notes.

LLM handoff

Copy a concise page brief or the full MDX source without digging through the docs shell.

Docs / API

Keep the live specimen near the contract.

Live preview

type SettingsSectionShellProps = {
  title: string
  form: ReactNode
  aside?: ReactNode
}

This shell is useful when a docs page needs live proof, API context, and compact implementation notes in one view.

ApiPreviewRail keeps the specimen and the contract close together so the reader does not have to choose between proof and implementation context.

Install

Purchase access, then open /account/install to issue a registry token.

import { ApiPreviewRail } from "@/registry/swiss/blocks/api-preview-rail"

Many docs pages split proof and API detail too far apart. This block keeps them in one authored composition.