Docs/Reference
Source guide3 min read

Find the right reference

Navigate portable models, runtime execution, adapters and generated contract records by responsibility.

Download Markdown ↓
Source and verification context ⌄

Source-guided

Inspect the source ↗

Repository links may require access. Source inspection is separate from a clean public-package installation.

AN INTERACTIVE READING MAP

Get the shape of this guide.

Move through the ideas, inspect their relationships, or make a focused reading path. The complete guide stays below.

READING SEQUENCEUnderstand how the ideas connect
Choose a point to look closer
01 / Guide section

Choose the reference that answers your question

Guides explain how to accomplish a task; reference records explain a particular surface. Start with the layer that owns your question so a package catalogue does not become your learning path.

Read the supporting context

The inspected generated manifest contains 1,300 records. The public explorer shows eligible public reference metadata; internal, mixed or unspecified records stay out of its default results. Reference records describe source surfaces, not independently verified tutorials.

Explore a section, then continue with the complete article below.

1 / 4

Choose the reference that answers your question

Guides explain how to accomplish a task; reference records explain a particular surface. Start with the layer that owns your question so a package catalogue does not become your learning path.

The inspected generated manifest contains 1,300 records. The public explorer shows eligible public reference metadata; internal, mixed or unspecified records stay out of its default results. Reference records describe source surfaces, not independently verified tutorials.

QuestionOwner to inspectUseful source
What does an operation declare?Portable contractscontracts-spec operation model
What runs before a handler?Runtime kerneloperations/prepare and registry
How does HTTP or MCP expose a call?Delivery adapterREST handler or MCP registration
How are role surfaces selected?Surface runtimeRoleMorph resolver
What does this specific contract contain?Generated referenceKey, version and declaration source
Where is a public import supported?Package export mapThe selected version's package.json
Give an agent a coherent slice of the system.Trace the mechanism · 3 ways to look closer

An agent is asked to change one operation. A useful context packet keeps the task, source identity and execution responsibilities together.

What does the agent need to do?
A CONCRETE SITUATION

Start with orientation and a bounded reference.

The task names a capability but not the package that owns it.

01 / Orient

Read the relevant area and task context.

What changes

An area overview and package overview narrow the source set.

What stays explicit

A package listing does not establish registry availability or permission to edit it.

FOLLOW THE CONSEQUENCE

Choose the relevant package and source identity, then follow the exact manual or structured source data.

Where this explanation comes from

An authored situation, grounded in the linked source guides. Choosing a case explores its expected responsibilities; it does not execute an operation.

Read a reference record

Use the contract key as its identity, then inspect the version, kind, ownership and stability where available. Follow the declaration source for the full model and the relevant handler or runtime for execution behavior.

A stability field describes the contract's declared status. It does not establish that an integration was exercised against a live provider or that a package has been installed outside the monorepo.

Understand generated lineage

The existing docs loader reads a manifest, loads metadata chunks and resolves each record's Markdown content from the generated docs tree. Update the owning declaration or DocBlock, then regenerate; do not make permanent edits to the generated JSON.

The inspected manifest uses a deterministic generatedAt value and has no release version. Treat that as a reproducibility mechanism with missing release provenance, not as a meaningful freshness date.

Move between explanation and exact detail

Use a concept page to understand a boundary, a guide to configure it, and a reference record to inspect the exact symbol or operation involved. Return to the guide for the next action instead of reading the entire reference inventory sequentially.

When a lookup gives no result, check aliases, exact operation key, the selected version and whether the relevant package was included in generation.

Continue from here.

Concepts

Contracts, handlers and adapters

3 min read

Understand the separate responsibilities that let one operation serve several interfaces.

Look inside the guideOpening context · complete reading path

The contract describes the behavior

An operation contract names a command or query and describes its data and requirements. The model includes metadata, input and output schemas, result definitions, policy, declared effects, transport hints and links to related presentations or tests.

Work through the guide
Operations

Version contracts and documentation together

3 min read

Keep operation identity, package releases and deployment revisions distinct when reviewing a change.

Look inside the guideOpening context · complete reading path

Know which version you mean

A contract's version identifies a particular declared behavior. A package version identifies a distribution artifact. A website or application revision identifies a deployment. Those numbers can change independently.

Work through the guide
Reference

Use the docs with coding agents

4 min read

Give an agent a small, versioned source set and keep documentation lookup separate from action authority.

Look inside the guideOpening context · complete reading path

Start with a focused context packet

Give the agent the task, selected package versions or source commit, the relevant guide, and the exact contract or runtime reference. A small coherent source set is easier to verify than the entire monorepo corpus.

Work through the guide
Next: Use the docs with coding agents →
Your view

Make room for your context.

Shape the presentation around this moment. You can change it whenever you need.

Your context

The different parts of you

Choose a starting point

A useful mix of context, visuals and gentle guidance.

Tune each dimension
Each dimension can change independently. Product permissions and available actions stay unchanged.

Support the way you begin and return

Tune your support

Reading comfort

Choose your language

Interface language changes text only. Markets, prices and workflows keep their own settings.

Translation coverage

Original source

Navigation151
Graph616
Categories378
Portfolio833
Examples2,035
Source preview1,542

More translations will be added as content is reviewed.

This preference is saved on this browser.

Search the website

Useful starting points

No results. Try a shorter phrase, an operation name or another search area.

A LITTLE ROOM TO EXPLORE

Find something to explore.

Open a closer look on this page, try a different perspective, or follow the detail into its own page.

How previews and controls work
01

Look before you leave

Hover a link or focus it with Tab to see a preview. Clicking the original link or pressing Enter always opens its destination.

02

Stay with the context

Move into the preview to explore its sections. Use Alt + ↓ from a focused link to enter it with the keyboard. Escape closes it.

03

Open the possibilities

Disclosure rows, perspective choices and highlighted controls reveal more. Your view changes reading comfort and the context you explore.

A separate button for a closer look

Show small preview buttons beside links where there is room. Tap the eye to inspect, or tap the link to go straight there. This choice stays in this tab.

No browsing history is collected. Reduced motion follows your device and Your view.