OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

Meetup-ready example

In‑App Documentation Example

Demonstrates using DocBlock to create user‑facing guides that live inside your application's frontend. It shows how to structure a public, non‑technical user guide using ContractSpec.

Open sandbox Generated reference

Sandbox preview

Load the same public browser surface used for the prepared live demo.

Open preview

Reference docs

Inspect the generated contract-facing material instead of relying on marketing summaries.

Open reference

Package context

Use the agent-facing package page for fast repo orientation, then jump to the source directory.

@contractspec/example.in-app-docs

LLMS page GitHub source

Talk commands

Exact local commands for the meetup lane

Build the example package, then launch the web shell and open the prepared docs or sandbox route.

in-app-docs-meetup-runbook

bun run --cwd packages/examples/in-app-docs build
bun run --cwd packages/apps/web-landing dev

# Open in the browser
# http://localhost:3000/docs/examples/in-app-docs
# http://localhost:3000/sandbox?template=in-app-docs

For the full fallback order and safe live-edit workflow, use the meetup runbook.

Live example

Embedded In‑App Documentation Example preview

This page embeds the reusable In‑App Documentation Example UI exported by the example package, so the docs lane and the live surface stay together.

Open system docs