Skip to content

Work / Babul / Wiki / Surfaces

docs-article

Surfacecanonicalverified 2026-10-23

SURFACE.WEB.DOCS.ARTICLE

Summary

One docs article. Quickstart, the four guides, CLI and MCP server use it.

Raw wireframes

  • .context/designs/web/docs/start/, product/, use/, team/ — one file per guide

Why it is drawn this way

  • One template for every guide: breadcrumb is the sidebar group; title only — no breadcrumb, lead or meta.
  • Onboarding and How to use carry a step bar for their group.
  • Every guide opens with "The example" — the Northwind story — then its first screenshot.
  • Screenshots are the app drawn in HTML, full width, one distinct screen each, with a caption.
  • Prev and next follow the sidebar order. "Who can" is in the meta line; the full table is only in Members and billing.

The example

Every screenshot follows example-northwind.

As built

  • The text of each guide is apps/web/content/docs/<group>/<slug>.md, rendered by one template (components/docs/). The HTML screens here stay the template's spec; a change to a guide's words is made in its Markdown file.
  • Screenshots are JPEG exports of the screens they show, in apps/web/public/docs/shots/. pnpm docs:shots makes them again after a screen changes.
  • Phone first: the sidebar folds into Menu, the step bar shows icons only, On this page shows from xl.
  • Not built: Was this page helpful, and Edit this page (the repo is private).