Docs/Reference
Guide source3 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

Examiner la 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.

SÉQUENCE DE LECTUREComprendre les liens entre les idées
Choose a point to look closer
01 / Section du guide

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.

Lire le contexte à l’appui

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?Contrats portablescontracts-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?Moteur d’exécution des interfacesRoleMorph 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?
UNE SITUATION CONCRÈTE

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.

Ce qui change

An area overview and package overview narrow the source set.

Ce qui reste explicite

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

SUIVRE LA CONSÉQUENCE

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 →
Votre vue

Make room for your context.

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

Votre contexte

The different parts of you

Choose a starting point

Un mélange utile de contexte, de visuels et de guidage discret.

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

Confort de lecture

Choisir votre langue

La langue de l’interface change uniquement le texte. Les marchés, les prix et les parcours conservent leurs propres paramètres.

Couverture des traductions

Une partie du contenu est affichée en anglais.

Navigation151
Graphe616
Catégories378
Portfolio833
Exemples2 035
Aperçu de la source1 542

D’autres traductions seront ajoutées à mesure que le contenu sera relu.

Cette préférence est enregistrée dans ce navigateur.

Rechercher sur le site

Des points de départ utiles

Aucun résultat. Essayez une expression plus courte, un nom d’opération ou un autre périmètre de recherche.

UN PEU DE PLACE POUR EXPLORER

Trouvez quelque chose à explorer.

Ouvrez un aperçu détaillé sur cette page, essayez une autre perspective ou suivez le détail vers sa propre page.

Fonctionnement des aperçus et des commandes
01

Regarder avant de partir

Survolez un lien ou sélectionnez-le avec Tab pour voir un aperçu. Cliquer sur le lien d’origine ou appuyer sur Entrée ouvre toujours sa destination.

02

Rester dans le contexte

Entrez dans l’aperçu pour explorer ses sections. Depuis un lien sélectionné, utilisez Alt + ↓ pour y entrer au clavier. Échap le ferme.

03

Ouvrir les possibilités

Les lignes dépliables, les choix de perspective et les commandes mises en évidence révèlent davantage. Votre vue adapte le confort de lecture et le contexte exploré.

Un bouton séparé pour voir de plus près

Affichez de petits boutons d’aperçu à côté des liens quand l’espace le permet. Touchez l’œil pour examiner ou le lien pour y aller directement. Ce choix reste dans cet onglet.

Aucun historique de navigation n’est collecté. La réduction des animations suit votre appareil et Votre vue.