@contractspec/bundle.library 3.10.0 → 3.10.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +212 -206
- package/CHANGELOG.md +43 -0
- package/dist/components/docs/DocsIndexPage.js +2 -2
- package/dist/components/docs/docsManifest.js +1 -1
- package/dist/components/docs/guides/GuideProviderBackedKnowledgePage.d.ts +1 -0
- package/dist/components/docs/guides/GuideProviderBackedKnowledgePage.js +73 -0
- package/dist/components/docs/guides/GuidesIndexPage.js +1 -1
- package/dist/components/docs/guides/guides.docblocks.js +10 -1
- package/dist/components/docs/guides/index.d.ts +1 -0
- package/dist/components/docs/guides/index.js +132 -52
- package/dist/components/docs/index.js +414 -284
- package/dist/components/docs/integrations/IntegrationsGmailPage.js +3 -3
- package/dist/components/docs/integrations/IntegrationsGoogleCalendarPage.js +1 -1
- package/dist/components/docs/integrations/IntegrationsGoogleDrivePage.d.ts +1 -0
- package/dist/components/docs/integrations/IntegrationsGoogleDrivePage.js +22 -0
- package/dist/components/docs/integrations/IntegrationsOverviewPage.js +1 -1
- package/dist/components/docs/integrations/index.d.ts +1 -0
- package/dist/components/docs/integrations/index.js +65 -45
- package/dist/components/docs/knowledge/KnowledgeGovernancePage.d.ts +1 -0
- package/dist/components/docs/knowledge/KnowledgeGovernancePage.js +23 -0
- package/dist/components/docs/knowledge/KnowledgeOverviewPage.js +1 -1
- package/dist/components/docs/knowledge/KnowledgeSourcesPage.js +11 -2
- package/dist/components/docs/knowledge/index.d.ts +1 -0
- package/dist/components/docs/knowledge/index.js +49 -19
- package/dist/index.js +430 -300
- package/dist/node/components/docs/DocsIndexPage.js +2 -2
- package/dist/node/components/docs/docsManifest.js +1 -1
- package/dist/node/components/docs/guides/GuideProviderBackedKnowledgePage.js +72 -0
- package/dist/node/components/docs/guides/GuidesIndexPage.js +1 -1
- package/dist/node/components/docs/guides/guides.docblocks.js +10 -1
- package/dist/node/components/docs/guides/index.js +132 -52
- package/dist/node/components/docs/index.js +414 -284
- package/dist/node/components/docs/integrations/IntegrationsGmailPage.js +3 -3
- package/dist/node/components/docs/integrations/IntegrationsGoogleCalendarPage.js +1 -1
- package/dist/node/components/docs/integrations/IntegrationsGoogleDrivePage.js +21 -0
- package/dist/node/components/docs/integrations/IntegrationsOverviewPage.js +1 -1
- package/dist/node/components/docs/integrations/index.js +65 -45
- package/dist/node/components/docs/knowledge/KnowledgeGovernancePage.js +22 -0
- package/dist/node/components/docs/knowledge/KnowledgeOverviewPage.js +1 -1
- package/dist/node/components/docs/knowledge/KnowledgeSourcesPage.js +11 -2
- package/dist/node/components/docs/knowledge/index.js +49 -19
- package/dist/node/index.js +430 -300
- package/package.json +59 -23
- package/src/components/docs/docsManifest.ts +62 -0
- package/src/components/docs/generated/docs-index._common.json +32 -0
- package/src/components/docs/generated/docs-index.manifest.json +2 -2
- package/src/components/docs/generated/docs-index.notifications.json +7 -7
- package/src/components/docs/guides/GuideProviderBackedKnowledgePage.tsx +191 -0
- package/src/components/docs/guides/GuidesIndexPage.tsx +7 -0
- package/src/components/docs/guides/guides.docblocks.ts +20 -0
- package/src/components/docs/guides/index.ts +1 -0
- package/src/components/docs/integrations/IntegrationsGmailPage.tsx +23 -2
- package/src/components/docs/integrations/IntegrationsGoogleCalendarPage.tsx +2 -2
- package/src/components/docs/integrations/IntegrationsGoogleDrivePage.tsx +88 -0
- package/src/components/docs/integrations/IntegrationsOverviewPage.tsx +1 -0
- package/src/components/docs/integrations/index.ts +1 -0
- package/src/components/docs/knowledge/KnowledgeGovernancePage.tsx +94 -0
- package/src/components/docs/knowledge/KnowledgeOverviewPage.tsx +10 -0
- package/src/components/docs/knowledge/KnowledgeSourcesPage.tsx +45 -0
- package/src/components/docs/knowledge/index.ts +1 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,48 @@
|
|
|
1
1
|
# @contractspec/bundle.library
|
|
2
2
|
|
|
3
|
+
## 3.10.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Add provider delta contracts, Google Drive knowledge ingestion, and governed mutation execution for workspace knowledge.
|
|
8
|
+
- Packages: @contractspec/lib.contracts-integrations (minor), @contractspec/lib.contracts-spec (minor), @contractspec/lib.knowledge (minor), @contractspec/bundle.library (patch), @contractspec/bundle.marketing (patch), @contractspec/app.web-landing (patch), @contractspec/example.knowledge-canon (patch)
|
|
9
|
+
- Updated dependencies because of chore: auto-bump internal dependents
|
|
10
|
+
- Updated dependencies because of Add provider delta contracts, Google Drive knowledge ingestion, and governed mutation execution for workspace knowledge.
|
|
11
|
+
- @contractspec/bundle.workspace@4.7.1
|
|
12
|
+
- @contractspec/example.data-grid-showcase@3.8.25
|
|
13
|
+
- @contractspec/lib.ai-providers@3.7.22
|
|
14
|
+
- @contractspec/lib.content-gen@3.7.29
|
|
15
|
+
- @contractspec/lib.contracts-library@3.7.29
|
|
16
|
+
- @contractspec/lib.contracts-runtime-client-react@3.14.2
|
|
17
|
+
- @contractspec/lib.contracts-runtime-server-graphql@3.8.8
|
|
18
|
+
- @contractspec/lib.contracts-runtime-server-mcp@3.8.9
|
|
19
|
+
- @contractspec/lib.contracts-runtime-server-rest@3.9.2
|
|
20
|
+
- @contractspec/lib.design-system@4.4.4
|
|
21
|
+
- @contractspec/lib.example-shared-ui@7.0.10
|
|
22
|
+
- @contractspec/lib.logger@3.7.22
|
|
23
|
+
- @contractspec/lib.provider-ranking@0.7.22
|
|
24
|
+
- @contractspec/lib.runtime-sandbox@3.0.8
|
|
25
|
+
- @contractspec/lib.surface-runtime@0.5.29
|
|
26
|
+
- @contractspec/lib.ui-kit-web@3.13.4
|
|
27
|
+
- @contractspec/lib.ui-link@3.7.24
|
|
28
|
+
- @contractspec/module.context-storage@0.7.28
|
|
29
|
+
- @contractspec/module.examples@4.0.10
|
|
30
|
+
- @contractspec/lib.contracts-integrations@3.10.0
|
|
31
|
+
- @contractspec/lib.contracts-spec@6.4.0
|
|
32
|
+
- @contractspec/lib.knowledge@3.9.0
|
|
33
|
+
|
|
34
|
+
## 3.10.1
|
|
35
|
+
|
|
36
|
+
### Patch Changes
|
|
37
|
+
|
|
38
|
+
- chore: auto-bump internal dependents
|
|
39
|
+
- Updated dependencies because of chore: auto-bump internal dependents
|
|
40
|
+
- Updated dependencies because of Improve PageOutline desktop behavior with a Notion-like floating rail, and hide the AppShell page outline on small web screens to preserve layout stability.
|
|
41
|
+
- @contractspec/example.data-grid-showcase@3.8.24
|
|
42
|
+
- @contractspec/lib.example-shared-ui@7.0.9
|
|
43
|
+
- @contractspec/module.examples@4.0.9
|
|
44
|
+
- @contractspec/lib.design-system@4.4.3
|
|
45
|
+
|
|
3
46
|
## 3.10.0
|
|
4
47
|
|
|
5
48
|
### Minor Changes
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
var m=Object.defineProperty;var h=(a)=>a;function f(a,r){this[a]=h.bind(null,r)}var S=(a,r)=>{for(var t in r)m(a,t,{get:r[t],enumerable:!0,configurable:!0,set:f.bind(r,t)})};var M=(a,r)=>()=>(a&&(r=a(a=0)),r);var c=[{key:"start",title:"Start",description:"Install ContractSpec, wire a first contract, and adopt it into an existing codebase."},{key:"core-model",title:"Core Model",description:"Learn how contracts, generated surfaces, policies, overlays, and safe regeneration fit together."},{key:"build",title:"Build",description:"Use practical guides, libraries, architecture patterns, and examples to ship real surfaces."},{key:"operate",title:"Operate",description:"Run the system safely with governance, auditability, tracing, and operator-grade controls."},{key:"integrations",title:"Integrations",description:"Connect models, messaging, storage, payments, search, and external systems through typed bindings."},{key:"reference",title:"Reference",description:"Search generated contract docs, inspect example packages, and navigate the system as source of truth."},{key:"studio",title:"Studio",description:"Understand what Studio adds on top of the open system and when to adopt it."}],n=[{href:"/docs",title:"Documentation",description:"OSS-first documentation for ContractSpec, the open spec system for AI-native software.",audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/start-here",title:"Start here",description:"The fastest path from install to your first contract and generated surface.",section:"start",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/installation",title:"Installation",description:"Install the CLI and core packages, then prepare a workspace for incremental adoption.",section:"start",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/hello-world",title:"Hello world",description:"Define a first operation, generate the surface, and verify the end-to-end loop.",section:"start",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/compatibility",title:"Compatibility",description:"Check the supported runtimes, package managers, and adoption assumptions before rollout.",section:"start",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/tools",title:"Developer tools",description:"Use the CLI, editors, and helper tooling that make the OSS workflow practical day to day.",section:"start",order:50,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/dataviews",title:"Display data with DataViews",description:"Define a query-backed DataView, render it on the frontend, and add preference-aware collection defaults.",section:"start",order:55,navTitle:"Display data",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["DataViews tutorial","DataView personalization tutorial"]},{href:"/docs/getting-started/troubleshooting",title:"Troubleshooting",description:"Resolve the common installation, validation, and runtime mistakes you hit during first adoption.",section:"start",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs",title:"Contracts and specs",description:"Understand the spec model that drives generated surfaces, validation, policy, and safe regeneration.",section:"core-model",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/capabilities",title:"Capabilities",description:"Model commands, queries, presentations, and events as explicit contract surfaces.",section:"core-model",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/dataviews",title:"Data views",description:"Define queryable, presentable views that stay aligned with the rest of the system.",section:"core-model",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/workflows",title:"Workflows",description:"Compose multi-step behavior from typed contracts, policies, and runtime orchestration.",section:"core-model",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/policy",title:"Policy",description:"Apply consistent governance, access rules, and risk controls across every surface.",section:"core-model",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/specs/overlays",title:"Overlays",description:"Customize generated surfaces safely without forking the system or breaking regeneration.",section:"core-model",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/module-bundles",title:"Module bundles",description:"Define AI-native surfaces as typed bundle specs that resolve into personalized, auditable runtime plans.",section:"core-model",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/connect",title:"ContractSpec Connect",description:"Guard coding-agent edits and shell actions with task-scoped context, plan packets, patch verdicts, and review packets.",section:"core-model",order:80,navTitle:"Connect",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/specs/builder-control-plane",title:"Builder control plane",description:"Route multimodal authoring work through governed builder contracts, provider policies, readiness gates, and mobile review flows.",section:"core-model",order:90,primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/guides/contract-types",title:"Contract types",description:"Choose the right contract surface for the behavior you want to make explicit.",section:"core-model",order:100,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides",title:"Guides",description:"Follow concrete adoption paths for existing apps, generated docs, CI gating, and typed surfaces.",section:"build",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/nextjs-one-endpoint",title:"Adopt one endpoint in Next.js",description:"Start with one endpoint, one contract, and one generated surface in an existing Next.js app.",section:"build",order:20,navTitle:"Next.js endpoint",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/import-existing-codebases",title:"Import an existing codebase",description:"Stabilize a live codebase incrementally instead of rewriting it from scratch.",section:"build",order:30,navTitle:"Import existing code",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/spec-validation-and-typing",title:"Validation and typing",description:"Keep runtime validation and TypeScript types aligned from the same source definitions.",section:"build",order:40,navTitle:"Validation and typing",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/contract-driven-forms",title:"Build a contract-driven form",description:"Define schema-backed form data, fields, layout, policy, and submit actions as one reusable ContractSpec surface.",section:"build",order:45,navTitle:"Contract-driven forms",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/data-exchange-import-templates",title:"Flexible import templates",description:"Publish a recommended data-exchange import shape while users import CSV, JSON, or XML files with alternate headers and localized values.",section:"build",order:47,navTitle:"Import templates",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["/docs/guides/import-templates","/docs/libraries/data-exchange"]},{href:"/docs/guides/generate-docs-clients-schemas",title:"Generate docs, clients, and schemas",description:"Export stable docs and client-facing artifacts from the same contract layer.",section:"build",order:50,navTitle:"Generate docs and clients",primaryNav:!0,audience:"oss",ctaMode:"reference"},{href:"/docs/guides/docs-generation-pipeline",title:"Docs generation pipeline",description:"Feed generated docs into the public docs site without breaking source-of-truth ownership.",section:"build",order:60,navTitle:"Docs pipeline",primaryNav:!0,audience:"oss",ctaMode:"reference"},{href:"/docs/guides/first-module-bundle",title:"Build a first module bundle",description:"Define one bundle spec, resolve a personalized surface plan, and render it through the React host layer.",section:"build",order:65,navTitle:"First module bundle",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/host-builder-workbench",title:"Host the Builder workbench",description:"Load a Builder workspace snapshot, wire common commands, and keep runtime mode plus mobile review flows explicit.",section:"build",order:66,navTitle:"Host Builder workbench",primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/guides/connect-in-a-repo",title:"Use Connect in a repo",description:"Enable Connect in workspace config, verify agent actions, and inspect local review and replay artifacts.",section:"build",order:67,navTitle:"Connect in a repo",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/libraries",title:"Libraries overview",description:"Navigate the core libraries, runtimes, and system packages that make up the open foundation.",section:"build",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/data-views",title:"DataViews runtime",description:"Render list, grid, and table DataViews with shared collection defaults, toolbar controls, data depth, and personalization bridges.",section:"build",order:71,navTitle:"DataViews runtime",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["DataViewRenderer","dataDepth","collection view modes"]},{href:"/docs/libraries/personalization",title:"Personalization",description:"Track behavior events, resolve DataView preferences, and convert insights into overlays or workflow adaptations.",section:"build",order:72,navTitle:"Personalization",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["resolveDataViewPreferences","trackDataViewInteraction","data_view_interaction"]},{href:"/docs/libraries/translation-runtime",title:"Translation runtime",description:"Use ContractSpec TranslationSpec catalogs as the canonical i18n layer, then resolve, format, snapshot, and optionally project messages to i18next.",section:"build",order:73,navTitle:"Translation runtime",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["i18n runtime","i18next adapter","translations"]},{href:"/docs/libraries/cross-platform-ui",title:"Cross-platform UI",description:"Understand how the presentation runtimes, ui-kit-web, ui-kit, and design-system stay aligned across React and React Native.",section:"build",order:74,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/application-shell",title:"Application shell",description:"Implement reusable app navigation with desktop sidebars, topbar breadcrumbs, command search, in-app notifications, mobile adapters, and PageOutline section navigation.",section:"build",order:75,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/design-system",title:"Design system",description:"Adopt high-level product UI primitives, actionable object references, responsive AdaptivePanel overlays, forms, data tables, and theme helpers.",section:"build",order:76,primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["object references","ObjectReferenceHandler","AdaptivePanel","adaptive panels","sheet drawer"]},{href:"/docs/architecture",title:"Architecture",description:"See how the spec layer, runtimes, integrations, and multi-surface outputs fit together.",section:"build",order:80,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/safety",title:"Operate safely",description:"Add auditability, migrations, policy controls, and trustworthy release behavior from the start.",section:"operate",order:10,navTitle:"Safety overview",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/guides/ci-contract-diff-gating",title:"CI diff gating",description:"Use deterministic checks to block drift and risky changes before they reach production.",section:"operate",order:20,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/guides/release-capsules",title:"Author release capsules",description:"Pair changesets with structured release capsules, generate release artifacts, and keep changelog plus docs surfaces aligned.",section:"operate",order:25,navTitle:"Release capsules",primaryNav:!0,audience:"operator",ctaMode:"reference"},{href:"/docs/safety/security-trust",title:"Security and trust",description:"Understand the trust model, artifact validation expectations, and operational boundaries.",section:"operate",order:30,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/auditing",title:"Audit trails",description:"Track changes, policy decisions, and operational actions with a clear evidence trail.",section:"operate",order:40,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/migrations",title:"Migrations",description:"Evolve schemas and data safely without abandoning the contract layer.",section:"operate",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/tenant-isolation",title:"Tenant isolation",description:"Keep tenant data, config, policies, and integrations separated at runtime.",section:"operate",order:60,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/knowledge",title:"Knowledge and context",description:"Bind trusted knowledge sources to the system without losing governance or isolation.",section:"operate",order:70,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/advanced/telemetry",title:"Telemetry",description:"Instrument surfaces, collect evidence, and keep observability aligned with the contract model.",section:"operate",order:80,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/advanced/workflow-monitoring",title:"Workflow monitoring",description:"Observe multi-step execution with enough context to understand failures and regressions.",section:"operate",order:90,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/ops/distributed-tracing",title:"Distributed tracing",description:"Trace contract execution across integrations, workflows, and generated surfaces.",section:"operate",order:100,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/integrations",title:"Integrations overview",description:"Understand the binding model for external services, providers, and tenant-owned connections.",section:"integrations",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/spec-model",title:"Integration spec model",description:"Define what an integration provides before wiring it into an app or runtime.",section:"integrations",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/openai",title:"OpenAI integration",description:"Connect OpenAI through typed capabilities, explicit provider config, and governed runtime usage.",section:"integrations",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/mistral",title:"Mistral integration",description:"Use Mistral through the same provider contract model and runtime guardrails.",section:"integrations",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/qdrant",title:"Qdrant integration",description:"Store and retrieve knowledge embeddings with explicit provider configuration and ownership.",section:"integrations",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/integrations/stripe",title:"Stripe integration",description:"Bind payments and billing behavior without smearing provider logic across the codebase.",section:"integrations",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/twilio",title:"Twilio integration",description:"Handle messaging and telephony through typed transport boundaries and explicit configuration.",section:"integrations",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/github",title:"GitHub integration",description:"Push execution context into GitHub workflows and automation surfaces without hidden glue.",section:"integrations",order:80,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/reference",title:"Contract reference",description:"Browse the generated reference index for public contract surfaces, versions, and examples.",section:"reference",order:10,primaryNav:!0,audience:"reference",ctaMode:"reference"},{href:"/docs/examples",title:"Examples",description:"Explore runnable examples and use them as reference implementations for new systems.",section:"reference",order:20,primaryNav:!0,audience:"reference",ctaMode:"reference"},{href:"/docs/studio",title:"Studio overview",description:"See what Studio adds on top of OSS ContractSpec and when a team should adopt the operating layer.",section:"studio",order:10,primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/manifesto",title:"Manifesto",description:"Why ContractSpec is built as an open system, how incremental adoption works, and why Studio stays additive.",audience:"secondary"},{href:"/docs/intent/contract-first-api",title:"Contract-first API",description:"Use contracts as the durable source of truth for API behavior and generated surfaces.",audience:"secondary"},{href:"/docs/intent/spec-driven-development",title:"Spec-driven development",description:"See how explicit specs stabilize change across APIs, UI, data, and agent-facing surfaces.",audience:"secondary"},{href:"/docs/intent/deterministic-codegen",title:"Deterministic regeneration",description:"Understand safe regeneration, conflict boundaries, and why teams keep control of the output.",audience:"secondary"},{href:"/docs/intent/schema-validation-typescript",title:"Schema validation and TypeScript",description:"Keep schema, runtime validation, and TypeScript behavior aligned without duplicate work.",audience:"secondary"},{href:"/docs/intent/openapi-alternative",title:"OpenAPI alternative",description:"Compare a multi-surface contract system with API-only description tooling.",audience:"secondary"},{href:"/docs/intent/generate-client-from-schema",title:"Generate client from schema",description:"Generate client-facing artifacts from the same source that drives runtime behavior.",audience:"secondary"},{href:"/docs/comparison",title:"Comparison overview",description:"Compare ContractSpec with workflow engines, internal-tool builders, and enterprise orchestration products.",audience:"secondary"},{href:"/docs/comparison/workflow-engines",title:"Workflow engines",description:"Contrast a contract system with workflow-only orchestration approaches.",audience:"secondary"},{href:"/docs/comparison/internal-tool-builders",title:"Internal-tool builders",description:"Compare ContractSpec with builders that optimize for screens instead of durable system contracts.",audience:"secondary"},{href:"/docs/comparison/automation-platforms",title:"Automation platforms",description:"Compare automation-first tools with a system that owns explicit contracts and generated surfaces.",audience:"secondary"},{href:"/docs/comparison/windmill",title:"Windmill comparison",description:"Understand where Windmill fits and where ContractSpec solves a different class of system problem.",audience:"secondary"},{href:"/docs/comparison/enterprise-platforms",title:"Enterprise orchestrators",description:"Compare ContractSpec with enterprise platforms that centralize execution in a closed operating surface.",audience:"secondary"},{href:"/docs/ecosystem/templates",title:"Templates",description:"Use templates and starter systems as proof points and accelerators for OSS adoption.",audience:"secondary"},{href:"/docs/ecosystem/plugins",title:"Plugins",description:"Explore marketplace and editor integrations that support the OSS workflow.",audience:"secondary"},{href:"/docs/ecosystem/registry",title:"Registry",description:"Inspect registry and manifest concepts that help package reusable capability surfaces.",audience:"secondary"}];function D(a){return n.find((r)=>r.href===a)}function g(){return c.map((a)=>({...a,items:n.filter((r)=>r.section===a.key&&r.primaryNav).sort((r,t)=>(r.order??0)-(t.order??0))}))}function y(){return n.filter((a)=>a.primaryNav).sort((a,r)=>c.findIndex((t)=>t.key===a.section)-c.findIndex((t)=>t.key===r.section)||(a.order??0)-(r.order??0))}function I(a){let r=y(),t=r.findIndex((o)=>o.href===a);if(t<0)return{previous:null,next:null};return{previous:r[t-1]??null,next:r[t+1]??null}}function l(){return n.filter((a)=>a.audience==="secondary")}function p(){return g().map((a)=>({...a,featured:a.items.slice(0,3)}))}import{CodeBlock as v}from"@contractspec/lib.design-system";import s from"@contractspec/lib.ui-link";import{ArrowRight as d,Boxes as u,FileSearch as b,ShieldCheck as w,Waypoints as N}from"lucide-react";import{jsx as e,jsxs as i}from"react/jsx-runtime";var k=[{title:"One system, many surfaces",body:"Define explicit contracts once, then keep APIs, UI, data, events, and agent-facing surfaces aligned.",icon:u},{title:"Incremental adoption",body:"Start with one endpoint, one workflow, or one unsafe module. You do not need a rewrite to begin.",icon:N},{title:"Operator-grade controls",body:"Carry policy, auditability, migrations, tracing, and integration boundaries forward with the same system model.",icon:w}],x=[{title:"ContractSpec Connect",body:"Guard coding-agent edits and commands with local-first context, plan packets, patch verdicts, and review packets.",specHref:"/docs/specs/connect",guideHref:"/docs/guides/connect-in-a-repo"},{title:"Module bundles",body:"Define AI-native surfaces as typed bundle specs that resolve into auditable runtime plans.",specHref:"/docs/specs/module-bundles",guideHref:"/docs/guides/first-module-bundle"},{title:"Builder control plane",body:"Coordinate multimodal authoring, provider routing, readiness, export, and mobile review through governed contracts.",specHref:"/docs/specs/builder-control-plane",guideHref:"/docs/guides/host-builder-workbench"}];function z(){let a=p(),r=l().slice(0,6);return i("div",{className:"space-y-12",children:[i("section",{className:"space-y-6",children:[e("p",{className:"editorial-kicker",children:"OSS documentation"}),e("h1",{className:"editorial-title max-w-5xl",children:"Build AI-native systems on explicit contracts, then add Studio when you want the operating layer."}),e("p",{className:"editorial-subtitle",children:"These docs are optimized for OSS adopters first. Learn the contract model, generate and govern surfaces safely, wire integrations, and run the system in production without giving up ownership of your code."}),i("div",{className:"flex flex-wrap gap-3",children:[i(s,{href:"/docs/getting-started/start-here",className:"btn-primary text-sm",children:["Start with OSS ",e(d,{size:16})]}),e(s,{href:"/docs/studio",className:"btn-ghost text-sm",children:"See what Studio adds"})]})]}),e("section",{className:"grid gap-5 md:grid-cols-3",children:k.map((t)=>{let o=t.icon;return i("article",{className:"editorial-panel space-y-3",children:[i("div",{className:"flex items-center gap-3",children:[e("div",{className:"rounded-full border border-border/80 bg-background/85 p-2",children:e(o,{size:18})}),e("h2",{className:"font-semibold text-xl",children:t.title})]}),e("p",{className:"editorial-copy text-sm",children:t.body})]},t.title)})}),i("section",{className:"space-y-5",children:[i("div",{className:"space-y-2",children:[e("p",{className:"editorial-kicker",children:"Implemented packs"}),e("h2",{className:"editorial-panel-title",children:"Use the three higher-order systems that are already wired"}),e("p",{className:"editorial-copy text-sm",children:"These pages are the canonical landing points for agent enforcement, AI-native surface composition, and Builder authoring. Each one now has a matching practical guide."})]}),e("div",{className:"grid gap-4 lg:grid-cols-3",children:x.map((t)=>i("article",{className:"editorial-panel space-y-4",children:[i("div",{children:[e("h3",{className:"font-semibold text-xl",children:t.title}),e("p",{className:"mt-2 text-muted-foreground text-sm leading-7",children:t.body})]}),i("div",{className:"flex flex-wrap gap-3",children:[i(s,{href:t.specHref,className:"btn-primary text-sm",children:["Open spec page ",e(d,{size:16})]}),e(s,{href:t.guideHref,className:"btn-ghost text-sm",children:"Read practical guide"})]})]},t.title))})]}),i("section",{className:"editorial-panel space-y-5",children:[i("div",{className:"space-y-2",children:[e("p",{className:"editorial-kicker",children:"Quick start"}),e("h2",{className:"editorial-panel-title",children:"Start with one contract"}),e("p",{className:"editorial-copy text-sm",children:"Use the CLI and core libraries to define one explicit capability, generate the surface, and validate the contract boundary before you expand."})]}),e(v,{language:"bash",filename:"docs-quick-start",code:`bun add -D contractspec
|
|
2
|
+
var m=Object.defineProperty;var h=(a)=>a;function g(a,r){this[a]=h.bind(null,r)}var S=(a,r)=>{for(var t in r)m(a,t,{get:r[t],enumerable:!0,configurable:!0,set:g.bind(r,t)})};var M=(a,r)=>()=>(a&&(r=a(a=0)),r);var c=[{key:"start",title:"Start",description:"Install ContractSpec, wire a first contract, and adopt it into an existing codebase."},{key:"core-model",title:"Core Model",description:"Learn how contracts, generated surfaces, policies, overlays, and safe regeneration fit together."},{key:"build",title:"Build",description:"Use practical guides, libraries, architecture patterns, and examples to ship real surfaces."},{key:"operate",title:"Operate",description:"Run the system safely with governance, auditability, tracing, and operator-grade controls."},{key:"integrations",title:"Integrations",description:"Connect models, messaging, storage, payments, search, and external systems through typed bindings."},{key:"reference",title:"Reference",description:"Search generated contract docs, inspect example packages, and navigate the system as source of truth."},{key:"studio",title:"Studio",description:"Understand what Studio adds on top of the open system and when to adopt it."}],n=[{href:"/docs",title:"Documentation",description:"OSS-first documentation for ContractSpec, the open spec system for AI-native software.",audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/start-here",title:"Start here",description:"The fastest path from install to your first contract and generated surface.",section:"start",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/installation",title:"Installation",description:"Install the CLI and core packages, then prepare a workspace for incremental adoption.",section:"start",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/hello-world",title:"Hello world",description:"Define a first operation, generate the surface, and verify the end-to-end loop.",section:"start",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/compatibility",title:"Compatibility",description:"Check the supported runtimes, package managers, and adoption assumptions before rollout.",section:"start",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/tools",title:"Developer tools",description:"Use the CLI, editors, and helper tooling that make the OSS workflow practical day to day.",section:"start",order:50,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/dataviews",title:"Display data with DataViews",description:"Define a query-backed DataView, render it on the frontend, and add preference-aware collection defaults.",section:"start",order:55,navTitle:"Display data",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["DataViews tutorial","DataView personalization tutorial"]},{href:"/docs/getting-started/troubleshooting",title:"Troubleshooting",description:"Resolve the common installation, validation, and runtime mistakes you hit during first adoption.",section:"start",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs",title:"Contracts and specs",description:"Understand the spec model that drives generated surfaces, validation, policy, and safe regeneration.",section:"core-model",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/capabilities",title:"Capabilities",description:"Model commands, queries, presentations, and events as explicit contract surfaces.",section:"core-model",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/dataviews",title:"Data views",description:"Define queryable, presentable views that stay aligned with the rest of the system.",section:"core-model",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/workflows",title:"Workflows",description:"Compose multi-step behavior from typed contracts, policies, and runtime orchestration.",section:"core-model",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/policy",title:"Policy",description:"Apply consistent governance, access rules, and risk controls across every surface.",section:"core-model",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/specs/overlays",title:"Overlays",description:"Customize generated surfaces safely without forking the system or breaking regeneration.",section:"core-model",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/module-bundles",title:"Module bundles",description:"Define AI-native surfaces as typed bundle specs that resolve into personalized, auditable runtime plans.",section:"core-model",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/connect",title:"ContractSpec Connect",description:"Guard coding-agent edits and shell actions with task-scoped context, plan packets, patch verdicts, and review packets.",section:"core-model",order:80,navTitle:"Connect",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/specs/builder-control-plane",title:"Builder control plane",description:"Route multimodal authoring work through governed builder contracts, provider policies, readiness gates, and mobile review flows.",section:"core-model",order:90,primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/guides/contract-types",title:"Contract types",description:"Choose the right contract surface for the behavior you want to make explicit.",section:"core-model",order:100,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides",title:"Guides",description:"Follow concrete adoption paths for existing apps, generated docs, CI gating, and typed surfaces.",section:"build",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/nextjs-one-endpoint",title:"Adopt one endpoint in Next.js",description:"Start with one endpoint, one contract, and one generated surface in an existing Next.js app.",section:"build",order:20,navTitle:"Next.js endpoint",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/import-existing-codebases",title:"Import an existing codebase",description:"Stabilize a live codebase incrementally instead of rewriting it from scratch.",section:"build",order:30,navTitle:"Import existing code",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/spec-validation-and-typing",title:"Validation and typing",description:"Keep runtime validation and TypeScript types aligned from the same source definitions.",section:"build",order:40,navTitle:"Validation and typing",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/contract-driven-forms",title:"Build a contract-driven form",description:"Define schema-backed form data, fields, layout, policy, and submit actions as one reusable ContractSpec surface.",section:"build",order:45,navTitle:"Contract-driven forms",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/data-exchange-import-templates",title:"Flexible import templates",description:"Publish a recommended data-exchange import shape while users import CSV, JSON, or XML files with alternate headers and localized values.",section:"build",order:47,navTitle:"Import templates",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["/docs/guides/import-templates","/docs/libraries/data-exchange"]},{href:"/docs/guides/generate-docs-clients-schemas",title:"Generate docs, clients, and schemas",description:"Export stable docs and client-facing artifacts from the same contract layer.",section:"build",order:50,navTitle:"Generate docs and clients",primaryNav:!0,audience:"oss",ctaMode:"reference"},{href:"/docs/guides/docs-generation-pipeline",title:"Docs generation pipeline",description:"Feed generated docs into the public docs site without breaking source-of-truth ownership.",section:"build",order:60,navTitle:"Docs pipeline",primaryNav:!0,audience:"oss",ctaMode:"reference"},{href:"/docs/guides/first-module-bundle",title:"Build a first module bundle",description:"Define one bundle spec, resolve a personalized surface plan, and render it through the React host layer.",section:"build",order:65,navTitle:"First module bundle",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/host-builder-workbench",title:"Host the Builder workbench",description:"Load a Builder workspace snapshot, wire common commands, and keep runtime mode plus mobile review flows explicit.",section:"build",order:66,navTitle:"Host Builder workbench",primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/guides/connect-in-a-repo",title:"Use Connect in a repo",description:"Enable Connect in workspace config, verify agent actions, and inspect local review and replay artifacts.",section:"build",order:67,navTitle:"Connect in a repo",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/guides/provider-backed-knowledge",title:"Adopt provider-backed knowledge",description:"Ingest Gmail and Google Drive into governed knowledge spaces with persisted provider deltas and mutation gates.",section:"build",order:68,navTitle:"Provider-backed knowledge",primaryNav:!0,audience:"operator",ctaMode:"oss-next",aliases:["Gmail knowledge ingestion","Google Drive knowledge ingestion","ProviderDeltaSyncState"]},{href:"/docs/libraries",title:"Libraries overview",description:"Navigate the core libraries, runtimes, and system packages that make up the open foundation.",section:"build",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/data-views",title:"DataViews runtime",description:"Render list, grid, and table DataViews with shared collection defaults, toolbar controls, data depth, and personalization bridges.",section:"build",order:71,navTitle:"DataViews runtime",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["DataViewRenderer","dataDepth","collection view modes"]},{href:"/docs/libraries/personalization",title:"Personalization",description:"Track behavior events, resolve DataView preferences, and convert insights into overlays or workflow adaptations.",section:"build",order:72,navTitle:"Personalization",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["resolveDataViewPreferences","trackDataViewInteraction","data_view_interaction"]},{href:"/docs/libraries/translation-runtime",title:"Translation runtime",description:"Use ContractSpec TranslationSpec catalogs as the canonical i18n layer, then resolve, format, snapshot, and optionally project messages to i18next.",section:"build",order:73,navTitle:"Translation runtime",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["i18n runtime","i18next adapter","translations"]},{href:"/docs/libraries/cross-platform-ui",title:"Cross-platform UI",description:"Understand how the presentation runtimes, ui-kit-web, ui-kit, and design-system stay aligned across React and React Native.",section:"build",order:74,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/application-shell",title:"Application shell",description:"Implement reusable app navigation with desktop sidebars, topbar breadcrumbs, command search, in-app notifications, mobile adapters, and PageOutline section navigation.",section:"build",order:75,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/design-system",title:"Design system",description:"Adopt high-level product UI primitives, actionable object references, responsive AdaptivePanel overlays, forms, data tables, and theme helpers.",section:"build",order:76,primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["object references","ObjectReferenceHandler","AdaptivePanel","adaptive panels","sheet drawer"]},{href:"/docs/architecture",title:"Architecture",description:"See how the spec layer, runtimes, integrations, and multi-surface outputs fit together.",section:"build",order:80,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/safety",title:"Operate safely",description:"Add auditability, migrations, policy controls, and trustworthy release behavior from the start.",section:"operate",order:10,navTitle:"Safety overview",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/guides/ci-contract-diff-gating",title:"CI diff gating",description:"Use deterministic checks to block drift and risky changes before they reach production.",section:"operate",order:20,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/guides/release-capsules",title:"Author release capsules",description:"Pair changesets with structured release capsules, generate release artifacts, and keep changelog plus docs surfaces aligned.",section:"operate",order:25,navTitle:"Release capsules",primaryNav:!0,audience:"operator",ctaMode:"reference"},{href:"/docs/safety/security-trust",title:"Security and trust",description:"Understand the trust model, artifact validation expectations, and operational boundaries.",section:"operate",order:30,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/auditing",title:"Audit trails",description:"Track changes, policy decisions, and operational actions with a clear evidence trail.",section:"operate",order:40,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/migrations",title:"Migrations",description:"Evolve schemas and data safely without abandoning the contract layer.",section:"operate",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/tenant-isolation",title:"Tenant isolation",description:"Keep tenant data, config, policies, and integrations separated at runtime.",section:"operate",order:60,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/knowledge",title:"Knowledge and context",description:"Bind trusted knowledge sources to the system without losing governance or isolation.",section:"operate",order:70,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/knowledge/governance",title:"Knowledge mutation governance",description:"Gate provider-backed knowledge mutations with dry-runs, approvals, idempotency, audit evidence, and outbound-send policy.",section:"operate",order:72,navTitle:"Knowledge governance",primaryNav:!0,audience:"operator",ctaMode:"oss-next",aliases:["knowledge.mutation.evaluateGovernance","KnowledgeMutationGovernance","outbound-send gates"]},{href:"/docs/advanced/telemetry",title:"Telemetry",description:"Instrument surfaces, collect evidence, and keep observability aligned with the contract model.",section:"operate",order:80,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/advanced/workflow-monitoring",title:"Workflow monitoring",description:"Observe multi-step execution with enough context to understand failures and regressions.",section:"operate",order:90,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/ops/distributed-tracing",title:"Distributed tracing",description:"Trace contract execution across integrations, workflows, and generated surfaces.",section:"operate",order:100,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/integrations",title:"Integrations overview",description:"Understand the binding model for external services, providers, and tenant-owned connections.",section:"integrations",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/spec-model",title:"Integration spec model",description:"Define what an integration provides before wiring it into an app or runtime.",section:"integrations",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/openai",title:"OpenAI integration",description:"Connect OpenAI through typed capabilities, explicit provider config, and governed runtime usage.",section:"integrations",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/mistral",title:"Mistral integration",description:"Use Mistral through the same provider contract model and runtime guardrails.",section:"integrations",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/qdrant",title:"Qdrant integration",description:"Store and retrieve knowledge embeddings with explicit provider configuration and ownership.",section:"integrations",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/integrations/gmail",title:"Gmail integration",description:"Ingest email threads through delta-aware provider contracts and governed outbound-send mutations.",section:"integrations",order:55,primaryNav:!0,audience:"operator",ctaMode:"oss-next",aliases:["email knowledge ingestion","Gmail delta sync"]},{href:"/docs/integrations/google-drive",title:"Google Drive integration",description:"Ingest Drive files and watches through explicit cursor, webhook, replay, dedupe, and tombstone contracts.",section:"integrations",order:56,primaryNav:!0,audience:"operator",ctaMode:"oss-next",aliases:["Drive knowledge ingestion","Google Drive watchChanges","ProviderDeltaSyncState"]},{href:"/docs/integrations/stripe",title:"Stripe integration",description:"Bind payments and billing behavior without smearing provider logic across the codebase.",section:"integrations",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/twilio",title:"Twilio integration",description:"Handle messaging and telephony through typed transport boundaries and explicit configuration.",section:"integrations",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/github",title:"GitHub integration",description:"Push execution context into GitHub workflows and automation surfaces without hidden glue.",section:"integrations",order:80,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/reference",title:"Contract reference",description:"Browse the generated reference index for public contract surfaces, versions, and examples.",section:"reference",order:10,primaryNav:!0,audience:"reference",ctaMode:"reference"},{href:"/docs/examples",title:"Examples",description:"Explore runnable examples and use them as reference implementations for new systems.",section:"reference",order:20,primaryNav:!0,audience:"reference",ctaMode:"reference"},{href:"/docs/studio",title:"Studio overview",description:"See what Studio adds on top of OSS ContractSpec and when a team should adopt the operating layer.",section:"studio",order:10,primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/manifesto",title:"Manifesto",description:"Why ContractSpec is built as an open system, how incremental adoption works, and why Studio stays additive.",audience:"secondary"},{href:"/docs/intent/contract-first-api",title:"Contract-first API",description:"Use contracts as the durable source of truth for API behavior and generated surfaces.",audience:"secondary"},{href:"/docs/intent/spec-driven-development",title:"Spec-driven development",description:"See how explicit specs stabilize change across APIs, UI, data, and agent-facing surfaces.",audience:"secondary"},{href:"/docs/intent/deterministic-codegen",title:"Deterministic regeneration",description:"Understand safe regeneration, conflict boundaries, and why teams keep control of the output.",audience:"secondary"},{href:"/docs/intent/schema-validation-typescript",title:"Schema validation and TypeScript",description:"Keep schema, runtime validation, and TypeScript behavior aligned without duplicate work.",audience:"secondary"},{href:"/docs/intent/openapi-alternative",title:"OpenAPI alternative",description:"Compare a multi-surface contract system with API-only description tooling.",audience:"secondary"},{href:"/docs/intent/generate-client-from-schema",title:"Generate client from schema",description:"Generate client-facing artifacts from the same source that drives runtime behavior.",audience:"secondary"},{href:"/docs/comparison",title:"Comparison overview",description:"Compare ContractSpec with workflow engines, internal-tool builders, and enterprise orchestration products.",audience:"secondary"},{href:"/docs/comparison/workflow-engines",title:"Workflow engines",description:"Contrast a contract system with workflow-only orchestration approaches.",audience:"secondary"},{href:"/docs/comparison/internal-tool-builders",title:"Internal-tool builders",description:"Compare ContractSpec with builders that optimize for screens instead of durable system contracts.",audience:"secondary"},{href:"/docs/comparison/automation-platforms",title:"Automation platforms",description:"Compare automation-first tools with a system that owns explicit contracts and generated surfaces.",audience:"secondary"},{href:"/docs/comparison/windmill",title:"Windmill comparison",description:"Understand where Windmill fits and where ContractSpec solves a different class of system problem.",audience:"secondary"},{href:"/docs/comparison/enterprise-platforms",title:"Enterprise orchestrators",description:"Compare ContractSpec with enterprise platforms that centralize execution in a closed operating surface.",audience:"secondary"},{href:"/docs/ecosystem/templates",title:"Templates",description:"Use templates and starter systems as proof points and accelerators for OSS adoption.",audience:"secondary"},{href:"/docs/ecosystem/plugins",title:"Plugins",description:"Explore marketplace and editor integrations that support the OSS workflow.",audience:"secondary"},{href:"/docs/ecosystem/registry",title:"Registry",description:"Inspect registry and manifest concepts that help package reusable capability surfaces.",audience:"secondary"}];function C(a){return n.find((r)=>r.href===a)}function f(){return c.map((a)=>({...a,items:n.filter((r)=>r.section===a.key&&r.primaryNav).sort((r,t)=>(r.order??0)-(t.order??0))}))}function y(){return n.filter((a)=>a.primaryNav).sort((a,r)=>c.findIndex((t)=>t.key===a.section)-c.findIndex((t)=>t.key===r.section)||(a.order??0)-(r.order??0))}function I(a){let r=y(),t=r.findIndex((o)=>o.href===a);if(t<0)return{previous:null,next:null};return{previous:r[t-1]??null,next:r[t+1]??null}}function l(){return n.filter((a)=>a.audience==="secondary")}function p(){return f().map((a)=>({...a,featured:a.items.slice(0,3)}))}import{CodeBlock as v}from"@contractspec/lib.design-system";import s from"@contractspec/lib.ui-link";import{ArrowRight as d,Boxes as u,FileSearch as b,ShieldCheck as w,Waypoints as N}from"lucide-react";import{jsx as e,jsxs as i}from"react/jsx-runtime";var k=[{title:"One system, many surfaces",body:"Define explicit contracts once, then keep APIs, UI, data, events, and agent-facing surfaces aligned.",icon:u},{title:"Incremental adoption",body:"Start with one endpoint, one workflow, or one unsafe module. You do not need a rewrite to begin.",icon:N},{title:"Operator-grade controls",body:"Carry policy, auditability, migrations, tracing, and integration boundaries forward with the same system model.",icon:w}],x=[{title:"ContractSpec Connect",body:"Guard coding-agent edits and commands with local-first context, plan packets, patch verdicts, and review packets.",specHref:"/docs/specs/connect",guideHref:"/docs/guides/connect-in-a-repo"},{title:"Module bundles",body:"Define AI-native surfaces as typed bundle specs that resolve into auditable runtime plans.",specHref:"/docs/specs/module-bundles",guideHref:"/docs/guides/first-module-bundle"},{title:"Builder control plane",body:"Coordinate multimodal authoring, provider routing, readiness, export, and mobile review through governed contracts.",specHref:"/docs/specs/builder-control-plane",guideHref:"/docs/guides/host-builder-workbench"}];function G(){let a=p(),r=l().slice(0,6);return i("div",{className:"space-y-12",children:[i("section",{className:"space-y-6",children:[e("p",{className:"editorial-kicker",children:"OSS documentation"}),e("h1",{className:"editorial-title max-w-5xl",children:"Build AI-native systems on explicit contracts, then add Studio when you want the operating layer."}),e("p",{className:"editorial-subtitle",children:"These docs are optimized for OSS adopters first. Learn the contract model, generate and govern surfaces safely, wire integrations, and run the system in production without giving up ownership of your code."}),i("div",{className:"flex flex-wrap gap-3",children:[i(s,{href:"/docs/getting-started/start-here",className:"btn-primary text-sm",children:["Start with OSS ",e(d,{size:16})]}),e(s,{href:"/docs/studio",className:"btn-ghost text-sm",children:"See what Studio adds"})]})]}),e("section",{className:"grid gap-5 md:grid-cols-3",children:k.map((t)=>{let o=t.icon;return i("article",{className:"editorial-panel space-y-3",children:[i("div",{className:"flex items-center gap-3",children:[e("div",{className:"rounded-full border border-border/80 bg-background/85 p-2",children:e(o,{size:18})}),e("h2",{className:"font-semibold text-xl",children:t.title})]}),e("p",{className:"editorial-copy text-sm",children:t.body})]},t.title)})}),i("section",{className:"space-y-5",children:[i("div",{className:"space-y-2",children:[e("p",{className:"editorial-kicker",children:"Implemented packs"}),e("h2",{className:"editorial-panel-title",children:"Use the three higher-order systems that are already wired"}),e("p",{className:"editorial-copy text-sm",children:"These pages are the canonical landing points for agent enforcement, AI-native surface composition, and Builder authoring. Each one now has a matching practical guide."})]}),e("div",{className:"grid gap-4 lg:grid-cols-3",children:x.map((t)=>i("article",{className:"editorial-panel space-y-4",children:[i("div",{children:[e("h3",{className:"font-semibold text-xl",children:t.title}),e("p",{className:"mt-2 text-muted-foreground text-sm leading-7",children:t.body})]}),i("div",{className:"flex flex-wrap gap-3",children:[i(s,{href:t.specHref,className:"btn-primary text-sm",children:["Open spec page ",e(d,{size:16})]}),e(s,{href:t.guideHref,className:"btn-ghost text-sm",children:"Read practical guide"})]})]},t.title))})]}),i("section",{className:"editorial-panel space-y-5",children:[i("div",{className:"space-y-2",children:[e("p",{className:"editorial-kicker",children:"Quick start"}),e("h2",{className:"editorial-panel-title",children:"Start with one contract"}),e("p",{className:"editorial-copy text-sm",children:"Use the CLI and core libraries to define one explicit capability, generate the surface, and validate the contract boundary before you expand."})]}),e(v,{language:"bash",filename:"docs-quick-start",code:`bun add -D contractspec
|
|
3
3
|
bun add @contractspec/lib.contracts-spec @contractspec/lib.schema
|
|
4
4
|
|
|
5
5
|
contractspec init
|
|
6
6
|
contractspec create --type operation
|
|
7
7
|
contractspec build src/contracts/mySpec.ts
|
|
8
|
-
contractspec validate src/contracts/mySpec.ts`})]}),i("section",{className:"space-y-5",children:[i("div",{className:"space-y-2",children:[e("p",{className:"editorial-kicker",children:"Primary path"}),e("h2",{className:"editorial-panel-title",children:"Move through the system in the right order"}),e("p",{className:"editorial-copy text-sm",children:"Start with onboarding, then learn the model, then build and operate with confidence. The primary docs path is intentionally shorter than the full route inventory."})]}),e("div",{className:"grid gap-5 lg:grid-cols-2",children:a.map((t)=>i("article",{className:"editorial-panel space-y-4",children:[i("div",{children:[e("p",{className:"editorial-kicker",children:t.title}),e("h3",{className:"mt-2 font-serif text-3xl tracking-[-0.03em]",children:t.title}),e("p",{className:"mt-3 text-muted-foreground text-sm leading-7",children:t.description})]}),e("div",{className:"space-y-3",children:t.featured.map((o)=>i(s,{href:o.href,className:"flex items-start justify-between gap-4 rounded-[22px] border border-border/70 bg-background/70 p-4 transition-colors hover:border-[color:rgb(162_79_42_/_0.45)]",children:[i("div",{children:[e("h4",{className:"font-semibold text-base",children:o.title}),e("p",{className:"mt-1 text-muted-foreground text-sm leading-6",children:o.description})]}),e(d,{className:"mt-1 shrink-0",size:16})]},o.href))})]},t.key))})]}),i("section",{className:"grid gap-5 lg:grid-cols-[1.2fr_0.8fr]",children:[i("article",{className:"editorial-panel space-y-4",children:[i("div",{className:"space-y-2",children:[e("p",{className:"editorial-kicker",children:"Reference and evidence"}),e("h2",{className:"editorial-panel-title",children:"Use generated docs and examples as proof, not just narrative copy"}),e("p",{className:"editorial-copy text-sm",children:"The reference index and example catalog stay close to the repo truth. Use them when you need exact public surfaces, not just the explanatory layer."})]}),i("div",{className:"grid gap-4 md:grid-cols-2",children:[i(s,{href:"/docs/reference",className:"docs-footer-link",children:[i("div",{className:"flex items-center gap-2 text-muted-foreground text-sm",children:[e(b,{size:16}),e("span",{children:"Reference index"})]}),e("p",{className:"text-muted-foreground text-sm",children:"Search generated contract docs, versions, tags, and visibility metadata."})]}),i(s,{href:"/docs/examples",className:"docs-footer-link",children:[i("div",{className:"flex items-center gap-2 text-muted-foreground text-sm",children:[e(u,{size:16}),e("span",{children:"Examples"})]}),e("p",{className:"text-muted-foreground text-sm",children:"Browse runnable examples and follow the reference routes back to their source artifacts."})]})]})]}),i("article",{className:"editorial-panel space-y-4",children:[i("div",{className:"space-y-2",children:[e("p",{className:"editorial-kicker",children:"Secondary reading"}),e("h2",{className:"editorial-panel-title",children:"Why ContractSpec"}),e("p",{className:"editorial-copy text-sm",children:"Positioning, comparisons, and philosophy remain available, but they no longer define the main docs path."})]}),e("div",{className:"flex flex-wrap gap-2",children:r.map((t)=>e(s,{href:t.href,className:"docs-chip-link",children:t.title},t.href))})]})]})]})}export{
|
|
8
|
+
contractspec validate src/contracts/mySpec.ts`})]}),i("section",{className:"space-y-5",children:[i("div",{className:"space-y-2",children:[e("p",{className:"editorial-kicker",children:"Primary path"}),e("h2",{className:"editorial-panel-title",children:"Move through the system in the right order"}),e("p",{className:"editorial-copy text-sm",children:"Start with onboarding, then learn the model, then build and operate with confidence. The primary docs path is intentionally shorter than the full route inventory."})]}),e("div",{className:"grid gap-5 lg:grid-cols-2",children:a.map((t)=>i("article",{className:"editorial-panel space-y-4",children:[i("div",{children:[e("p",{className:"editorial-kicker",children:t.title}),e("h3",{className:"mt-2 font-serif text-3xl tracking-[-0.03em]",children:t.title}),e("p",{className:"mt-3 text-muted-foreground text-sm leading-7",children:t.description})]}),e("div",{className:"space-y-3",children:t.featured.map((o)=>i(s,{href:o.href,className:"flex items-start justify-between gap-4 rounded-[22px] border border-border/70 bg-background/70 p-4 transition-colors hover:border-[color:rgb(162_79_42_/_0.45)]",children:[i("div",{children:[e("h4",{className:"font-semibold text-base",children:o.title}),e("p",{className:"mt-1 text-muted-foreground text-sm leading-6",children:o.description})]}),e(d,{className:"mt-1 shrink-0",size:16})]},o.href))})]},t.key))})]}),i("section",{className:"grid gap-5 lg:grid-cols-[1.2fr_0.8fr]",children:[i("article",{className:"editorial-panel space-y-4",children:[i("div",{className:"space-y-2",children:[e("p",{className:"editorial-kicker",children:"Reference and evidence"}),e("h2",{className:"editorial-panel-title",children:"Use generated docs and examples as proof, not just narrative copy"}),e("p",{className:"editorial-copy text-sm",children:"The reference index and example catalog stay close to the repo truth. Use them when you need exact public surfaces, not just the explanatory layer."})]}),i("div",{className:"grid gap-4 md:grid-cols-2",children:[i(s,{href:"/docs/reference",className:"docs-footer-link",children:[i("div",{className:"flex items-center gap-2 text-muted-foreground text-sm",children:[e(b,{size:16}),e("span",{children:"Reference index"})]}),e("p",{className:"text-muted-foreground text-sm",children:"Search generated contract docs, versions, tags, and visibility metadata."})]}),i(s,{href:"/docs/examples",className:"docs-footer-link",children:[i("div",{className:"flex items-center gap-2 text-muted-foreground text-sm",children:[e(u,{size:16}),e("span",{children:"Examples"})]}),e("p",{className:"text-muted-foreground text-sm",children:"Browse runnable examples and follow the reference routes back to their source artifacts."})]})]})]}),i("article",{className:"editorial-panel space-y-4",children:[i("div",{className:"space-y-2",children:[e("p",{className:"editorial-kicker",children:"Secondary reading"}),e("h2",{className:"editorial-panel-title",children:"Why ContractSpec"}),e("p",{className:"editorial-copy text-sm",children:"Positioning, comparisons, and philosophy remain available, but they no longer define the main docs path."})]}),e("div",{className:"flex flex-wrap gap-2",children:r.map((t)=>e(s,{href:t.href,className:"docs-chip-link",children:t.title},t.href))})]})]})]})}export{G as DocsIndexPage};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
var s=Object.defineProperty;var n=(e)=>e;function c(e,t){this[e]=n.bind(null,t)}var p=(e,t)=>{for(var r in t)s(e,r,{get:t[r],enumerable:!0,configurable:!0,set:c.bind(t,r)})};var u=(e,t)=>()=>(e&&(t=e(e=0)),t);var o=[{key:"start",title:"Start",description:"Install ContractSpec, wire a first contract, and adopt it into an existing codebase."},{key:"core-model",title:"Core Model",description:"Learn how contracts, generated surfaces, policies, overlays, and safe regeneration fit together."},{key:"build",title:"Build",description:"Use practical guides, libraries, architecture patterns, and examples to ship real surfaces."},{key:"operate",title:"Operate",description:"Run the system safely with governance, auditability, tracing, and operator-grade controls."},{key:"integrations",title:"Integrations",description:"Connect models, messaging, storage, payments, search, and external systems through typed bindings."},{key:"reference",title:"Reference",description:"Search generated contract docs, inspect example packages, and navigate the system as source of truth."},{key:"studio",title:"Studio",description:"Understand what Studio adds on top of the open system and when to adopt it."}],i=[{href:"/docs",title:"Documentation",description:"OSS-first documentation for ContractSpec, the open spec system for AI-native software.",audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/start-here",title:"Start here",description:"The fastest path from install to your first contract and generated surface.",section:"start",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/installation",title:"Installation",description:"Install the CLI and core packages, then prepare a workspace for incremental adoption.",section:"start",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/hello-world",title:"Hello world",description:"Define a first operation, generate the surface, and verify the end-to-end loop.",section:"start",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/compatibility",title:"Compatibility",description:"Check the supported runtimes, package managers, and adoption assumptions before rollout.",section:"start",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/tools",title:"Developer tools",description:"Use the CLI, editors, and helper tooling that make the OSS workflow practical day to day.",section:"start",order:50,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/dataviews",title:"Display data with DataViews",description:"Define a query-backed DataView, render it on the frontend, and add preference-aware collection defaults.",section:"start",order:55,navTitle:"Display data",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["DataViews tutorial","DataView personalization tutorial"]},{href:"/docs/getting-started/troubleshooting",title:"Troubleshooting",description:"Resolve the common installation, validation, and runtime mistakes you hit during first adoption.",section:"start",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs",title:"Contracts and specs",description:"Understand the spec model that drives generated surfaces, validation, policy, and safe regeneration.",section:"core-model",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/capabilities",title:"Capabilities",description:"Model commands, queries, presentations, and events as explicit contract surfaces.",section:"core-model",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/dataviews",title:"Data views",description:"Define queryable, presentable views that stay aligned with the rest of the system.",section:"core-model",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/workflows",title:"Workflows",description:"Compose multi-step behavior from typed contracts, policies, and runtime orchestration.",section:"core-model",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/policy",title:"Policy",description:"Apply consistent governance, access rules, and risk controls across every surface.",section:"core-model",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/specs/overlays",title:"Overlays",description:"Customize generated surfaces safely without forking the system or breaking regeneration.",section:"core-model",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/module-bundles",title:"Module bundles",description:"Define AI-native surfaces as typed bundle specs that resolve into personalized, auditable runtime plans.",section:"core-model",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/connect",title:"ContractSpec Connect",description:"Guard coding-agent edits and shell actions with task-scoped context, plan packets, patch verdicts, and review packets.",section:"core-model",order:80,navTitle:"Connect",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/specs/builder-control-plane",title:"Builder control plane",description:"Route multimodal authoring work through governed builder contracts, provider policies, readiness gates, and mobile review flows.",section:"core-model",order:90,primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/guides/contract-types",title:"Contract types",description:"Choose the right contract surface for the behavior you want to make explicit.",section:"core-model",order:100,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides",title:"Guides",description:"Follow concrete adoption paths for existing apps, generated docs, CI gating, and typed surfaces.",section:"build",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/nextjs-one-endpoint",title:"Adopt one endpoint in Next.js",description:"Start with one endpoint, one contract, and one generated surface in an existing Next.js app.",section:"build",order:20,navTitle:"Next.js endpoint",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/import-existing-codebases",title:"Import an existing codebase",description:"Stabilize a live codebase incrementally instead of rewriting it from scratch.",section:"build",order:30,navTitle:"Import existing code",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/spec-validation-and-typing",title:"Validation and typing",description:"Keep runtime validation and TypeScript types aligned from the same source definitions.",section:"build",order:40,navTitle:"Validation and typing",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/contract-driven-forms",title:"Build a contract-driven form",description:"Define schema-backed form data, fields, layout, policy, and submit actions as one reusable ContractSpec surface.",section:"build",order:45,navTitle:"Contract-driven forms",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/data-exchange-import-templates",title:"Flexible import templates",description:"Publish a recommended data-exchange import shape while users import CSV, JSON, or XML files with alternate headers and localized values.",section:"build",order:47,navTitle:"Import templates",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["/docs/guides/import-templates","/docs/libraries/data-exchange"]},{href:"/docs/guides/generate-docs-clients-schemas",title:"Generate docs, clients, and schemas",description:"Export stable docs and client-facing artifacts from the same contract layer.",section:"build",order:50,navTitle:"Generate docs and clients",primaryNav:!0,audience:"oss",ctaMode:"reference"},{href:"/docs/guides/docs-generation-pipeline",title:"Docs generation pipeline",description:"Feed generated docs into the public docs site without breaking source-of-truth ownership.",section:"build",order:60,navTitle:"Docs pipeline",primaryNav:!0,audience:"oss",ctaMode:"reference"},{href:"/docs/guides/first-module-bundle",title:"Build a first module bundle",description:"Define one bundle spec, resolve a personalized surface plan, and render it through the React host layer.",section:"build",order:65,navTitle:"First module bundle",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/host-builder-workbench",title:"Host the Builder workbench",description:"Load a Builder workspace snapshot, wire common commands, and keep runtime mode plus mobile review flows explicit.",section:"build",order:66,navTitle:"Host Builder workbench",primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/guides/connect-in-a-repo",title:"Use Connect in a repo",description:"Enable Connect in workspace config, verify agent actions, and inspect local review and replay artifacts.",section:"build",order:67,navTitle:"Connect in a repo",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/libraries",title:"Libraries overview",description:"Navigate the core libraries, runtimes, and system packages that make up the open foundation.",section:"build",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/data-views",title:"DataViews runtime",description:"Render list, grid, and table DataViews with shared collection defaults, toolbar controls, data depth, and personalization bridges.",section:"build",order:71,navTitle:"DataViews runtime",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["DataViewRenderer","dataDepth","collection view modes"]},{href:"/docs/libraries/personalization",title:"Personalization",description:"Track behavior events, resolve DataView preferences, and convert insights into overlays or workflow adaptations.",section:"build",order:72,navTitle:"Personalization",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["resolveDataViewPreferences","trackDataViewInteraction","data_view_interaction"]},{href:"/docs/libraries/translation-runtime",title:"Translation runtime",description:"Use ContractSpec TranslationSpec catalogs as the canonical i18n layer, then resolve, format, snapshot, and optionally project messages to i18next.",section:"build",order:73,navTitle:"Translation runtime",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["i18n runtime","i18next adapter","translations"]},{href:"/docs/libraries/cross-platform-ui",title:"Cross-platform UI",description:"Understand how the presentation runtimes, ui-kit-web, ui-kit, and design-system stay aligned across React and React Native.",section:"build",order:74,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/application-shell",title:"Application shell",description:"Implement reusable app navigation with desktop sidebars, topbar breadcrumbs, command search, in-app notifications, mobile adapters, and PageOutline section navigation.",section:"build",order:75,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/design-system",title:"Design system",description:"Adopt high-level product UI primitives, actionable object references, responsive AdaptivePanel overlays, forms, data tables, and theme helpers.",section:"build",order:76,primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["object references","ObjectReferenceHandler","AdaptivePanel","adaptive panels","sheet drawer"]},{href:"/docs/architecture",title:"Architecture",description:"See how the spec layer, runtimes, integrations, and multi-surface outputs fit together.",section:"build",order:80,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/safety",title:"Operate safely",description:"Add auditability, migrations, policy controls, and trustworthy release behavior from the start.",section:"operate",order:10,navTitle:"Safety overview",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/guides/ci-contract-diff-gating",title:"CI diff gating",description:"Use deterministic checks to block drift and risky changes before they reach production.",section:"operate",order:20,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/guides/release-capsules",title:"Author release capsules",description:"Pair changesets with structured release capsules, generate release artifacts, and keep changelog plus docs surfaces aligned.",section:"operate",order:25,navTitle:"Release capsules",primaryNav:!0,audience:"operator",ctaMode:"reference"},{href:"/docs/safety/security-trust",title:"Security and trust",description:"Understand the trust model, artifact validation expectations, and operational boundaries.",section:"operate",order:30,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/auditing",title:"Audit trails",description:"Track changes, policy decisions, and operational actions with a clear evidence trail.",section:"operate",order:40,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/migrations",title:"Migrations",description:"Evolve schemas and data safely without abandoning the contract layer.",section:"operate",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/tenant-isolation",title:"Tenant isolation",description:"Keep tenant data, config, policies, and integrations separated at runtime.",section:"operate",order:60,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/knowledge",title:"Knowledge and context",description:"Bind trusted knowledge sources to the system without losing governance or isolation.",section:"operate",order:70,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/advanced/telemetry",title:"Telemetry",description:"Instrument surfaces, collect evidence, and keep observability aligned with the contract model.",section:"operate",order:80,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/advanced/workflow-monitoring",title:"Workflow monitoring",description:"Observe multi-step execution with enough context to understand failures and regressions.",section:"operate",order:90,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/ops/distributed-tracing",title:"Distributed tracing",description:"Trace contract execution across integrations, workflows, and generated surfaces.",section:"operate",order:100,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/integrations",title:"Integrations overview",description:"Understand the binding model for external services, providers, and tenant-owned connections.",section:"integrations",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/spec-model",title:"Integration spec model",description:"Define what an integration provides before wiring it into an app or runtime.",section:"integrations",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/openai",title:"OpenAI integration",description:"Connect OpenAI through typed capabilities, explicit provider config, and governed runtime usage.",section:"integrations",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/mistral",title:"Mistral integration",description:"Use Mistral through the same provider contract model and runtime guardrails.",section:"integrations",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/qdrant",title:"Qdrant integration",description:"Store and retrieve knowledge embeddings with explicit provider configuration and ownership.",section:"integrations",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/integrations/stripe",title:"Stripe integration",description:"Bind payments and billing behavior without smearing provider logic across the codebase.",section:"integrations",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/twilio",title:"Twilio integration",description:"Handle messaging and telephony through typed transport boundaries and explicit configuration.",section:"integrations",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/github",title:"GitHub integration",description:"Push execution context into GitHub workflows and automation surfaces without hidden glue.",section:"integrations",order:80,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/reference",title:"Contract reference",description:"Browse the generated reference index for public contract surfaces, versions, and examples.",section:"reference",order:10,primaryNav:!0,audience:"reference",ctaMode:"reference"},{href:"/docs/examples",title:"Examples",description:"Explore runnable examples and use them as reference implementations for new systems.",section:"reference",order:20,primaryNav:!0,audience:"reference",ctaMode:"reference"},{href:"/docs/studio",title:"Studio overview",description:"See what Studio adds on top of OSS ContractSpec and when a team should adopt the operating layer.",section:"studio",order:10,primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/manifesto",title:"Manifesto",description:"Why ContractSpec is built as an open system, how incremental adoption works, and why Studio stays additive.",audience:"secondary"},{href:"/docs/intent/contract-first-api",title:"Contract-first API",description:"Use contracts as the durable source of truth for API behavior and generated surfaces.",audience:"secondary"},{href:"/docs/intent/spec-driven-development",title:"Spec-driven development",description:"See how explicit specs stabilize change across APIs, UI, data, and agent-facing surfaces.",audience:"secondary"},{href:"/docs/intent/deterministic-codegen",title:"Deterministic regeneration",description:"Understand safe regeneration, conflict boundaries, and why teams keep control of the output.",audience:"secondary"},{href:"/docs/intent/schema-validation-typescript",title:"Schema validation and TypeScript",description:"Keep schema, runtime validation, and TypeScript behavior aligned without duplicate work.",audience:"secondary"},{href:"/docs/intent/openapi-alternative",title:"OpenAPI alternative",description:"Compare a multi-surface contract system with API-only description tooling.",audience:"secondary"},{href:"/docs/intent/generate-client-from-schema",title:"Generate client from schema",description:"Generate client-facing artifacts from the same source that drives runtime behavior.",audience:"secondary"},{href:"/docs/comparison",title:"Comparison overview",description:"Compare ContractSpec with workflow engines, internal-tool builders, and enterprise orchestration products.",audience:"secondary"},{href:"/docs/comparison/workflow-engines",title:"Workflow engines",description:"Contrast a contract system with workflow-only orchestration approaches.",audience:"secondary"},{href:"/docs/comparison/internal-tool-builders",title:"Internal-tool builders",description:"Compare ContractSpec with builders that optimize for screens instead of durable system contracts.",audience:"secondary"},{href:"/docs/comparison/automation-platforms",title:"Automation platforms",description:"Compare automation-first tools with a system that owns explicit contracts and generated surfaces.",audience:"secondary"},{href:"/docs/comparison/windmill",title:"Windmill comparison",description:"Understand where Windmill fits and where ContractSpec solves a different class of system problem.",audience:"secondary"},{href:"/docs/comparison/enterprise-platforms",title:"Enterprise orchestrators",description:"Compare ContractSpec with enterprise platforms that centralize execution in a closed operating surface.",audience:"secondary"},{href:"/docs/ecosystem/templates",title:"Templates",description:"Use templates and starter systems as proof points and accelerators for OSS adoption.",audience:"secondary"},{href:"/docs/ecosystem/plugins",title:"Plugins",description:"Explore marketplace and editor integrations that support the OSS workflow.",audience:"secondary"},{href:"/docs/ecosystem/registry",title:"Registry",description:"Inspect registry and manifest concepts that help package reusable capability surfaces.",audience:"secondary"}];function h(e){return i.find((t)=>t.href===e)}function d(){return o.map((e)=>({...e,items:i.filter((t)=>t.section===e.key&&t.primaryNav).sort((t,r)=>(t.order??0)-(r.order??0))}))}function l(){return i.filter((e)=>e.primaryNav).sort((e,t)=>o.findIndex((r)=>r.key===e.section)-o.findIndex((r)=>r.key===t.section)||(e.order??0)-(t.order??0))}function f(e){let t=l(),r=t.findIndex((a)=>a.href===e);if(r<0)return{previous:null,next:null};return{previous:t[r-1]??null,next:t[r+1]??null}}function g(){return i.filter((e)=>e.audience==="secondary")}function y(){return d().map((e)=>({...e,featured:e.items.slice(0,3)}))}export{g as getSecondaryDocsPages,l as getPrimaryDocsTraversal,d as getPrimaryDocsSections,h as getDocsPageByHref,f as getDocsNextPrevious,y as getDocsHomeSections,o as DOCS_PRIMARY_SECTIONS,i as DOCS_PAGES};
|
|
2
|
+
var s=Object.defineProperty;var n=(e)=>e;function d(e,t){this[e]=n.bind(null,t)}var p=(e,t)=>{for(var r in t)s(e,r,{get:t[r],enumerable:!0,configurable:!0,set:d.bind(t,r)})};var u=(e,t)=>()=>(e&&(t=e(e=0)),t);var o=[{key:"start",title:"Start",description:"Install ContractSpec, wire a first contract, and adopt it into an existing codebase."},{key:"core-model",title:"Core Model",description:"Learn how contracts, generated surfaces, policies, overlays, and safe regeneration fit together."},{key:"build",title:"Build",description:"Use practical guides, libraries, architecture patterns, and examples to ship real surfaces."},{key:"operate",title:"Operate",description:"Run the system safely with governance, auditability, tracing, and operator-grade controls."},{key:"integrations",title:"Integrations",description:"Connect models, messaging, storage, payments, search, and external systems through typed bindings."},{key:"reference",title:"Reference",description:"Search generated contract docs, inspect example packages, and navigate the system as source of truth."},{key:"studio",title:"Studio",description:"Understand what Studio adds on top of the open system and when to adopt it."}],i=[{href:"/docs",title:"Documentation",description:"OSS-first documentation for ContractSpec, the open spec system for AI-native software.",audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/start-here",title:"Start here",description:"The fastest path from install to your first contract and generated surface.",section:"start",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/installation",title:"Installation",description:"Install the CLI and core packages, then prepare a workspace for incremental adoption.",section:"start",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/hello-world",title:"Hello world",description:"Define a first operation, generate the surface, and verify the end-to-end loop.",section:"start",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/compatibility",title:"Compatibility",description:"Check the supported runtimes, package managers, and adoption assumptions before rollout.",section:"start",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/tools",title:"Developer tools",description:"Use the CLI, editors, and helper tooling that make the OSS workflow practical day to day.",section:"start",order:50,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/getting-started/dataviews",title:"Display data with DataViews",description:"Define a query-backed DataView, render it on the frontend, and add preference-aware collection defaults.",section:"start",order:55,navTitle:"Display data",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["DataViews tutorial","DataView personalization tutorial"]},{href:"/docs/getting-started/troubleshooting",title:"Troubleshooting",description:"Resolve the common installation, validation, and runtime mistakes you hit during first adoption.",section:"start",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs",title:"Contracts and specs",description:"Understand the spec model that drives generated surfaces, validation, policy, and safe regeneration.",section:"core-model",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/capabilities",title:"Capabilities",description:"Model commands, queries, presentations, and events as explicit contract surfaces.",section:"core-model",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/dataviews",title:"Data views",description:"Define queryable, presentable views that stay aligned with the rest of the system.",section:"core-model",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/workflows",title:"Workflows",description:"Compose multi-step behavior from typed contracts, policies, and runtime orchestration.",section:"core-model",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/policy",title:"Policy",description:"Apply consistent governance, access rules, and risk controls across every surface.",section:"core-model",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/specs/overlays",title:"Overlays",description:"Customize generated surfaces safely without forking the system or breaking regeneration.",section:"core-model",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/module-bundles",title:"Module bundles",description:"Define AI-native surfaces as typed bundle specs that resolve into personalized, auditable runtime plans.",section:"core-model",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/specs/connect",title:"ContractSpec Connect",description:"Guard coding-agent edits and shell actions with task-scoped context, plan packets, patch verdicts, and review packets.",section:"core-model",order:80,navTitle:"Connect",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/specs/builder-control-plane",title:"Builder control plane",description:"Route multimodal authoring work through governed builder contracts, provider policies, readiness gates, and mobile review flows.",section:"core-model",order:90,primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/guides/contract-types",title:"Contract types",description:"Choose the right contract surface for the behavior you want to make explicit.",section:"core-model",order:100,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides",title:"Guides",description:"Follow concrete adoption paths for existing apps, generated docs, CI gating, and typed surfaces.",section:"build",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/nextjs-one-endpoint",title:"Adopt one endpoint in Next.js",description:"Start with one endpoint, one contract, and one generated surface in an existing Next.js app.",section:"build",order:20,navTitle:"Next.js endpoint",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/import-existing-codebases",title:"Import an existing codebase",description:"Stabilize a live codebase incrementally instead of rewriting it from scratch.",section:"build",order:30,navTitle:"Import existing code",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/spec-validation-and-typing",title:"Validation and typing",description:"Keep runtime validation and TypeScript types aligned from the same source definitions.",section:"build",order:40,navTitle:"Validation and typing",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/contract-driven-forms",title:"Build a contract-driven form",description:"Define schema-backed form data, fields, layout, policy, and submit actions as one reusable ContractSpec surface.",section:"build",order:45,navTitle:"Contract-driven forms",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/data-exchange-import-templates",title:"Flexible import templates",description:"Publish a recommended data-exchange import shape while users import CSV, JSON, or XML files with alternate headers and localized values.",section:"build",order:47,navTitle:"Import templates",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["/docs/guides/import-templates","/docs/libraries/data-exchange"]},{href:"/docs/guides/generate-docs-clients-schemas",title:"Generate docs, clients, and schemas",description:"Export stable docs and client-facing artifacts from the same contract layer.",section:"build",order:50,navTitle:"Generate docs and clients",primaryNav:!0,audience:"oss",ctaMode:"reference"},{href:"/docs/guides/docs-generation-pipeline",title:"Docs generation pipeline",description:"Feed generated docs into the public docs site without breaking source-of-truth ownership.",section:"build",order:60,navTitle:"Docs pipeline",primaryNav:!0,audience:"oss",ctaMode:"reference"},{href:"/docs/guides/first-module-bundle",title:"Build a first module bundle",description:"Define one bundle spec, resolve a personalized surface plan, and render it through the React host layer.",section:"build",order:65,navTitle:"First module bundle",primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/guides/host-builder-workbench",title:"Host the Builder workbench",description:"Load a Builder workspace snapshot, wire common commands, and keep runtime mode plus mobile review flows explicit.",section:"build",order:66,navTitle:"Host Builder workbench",primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/guides/connect-in-a-repo",title:"Use Connect in a repo",description:"Enable Connect in workspace config, verify agent actions, and inspect local review and replay artifacts.",section:"build",order:67,navTitle:"Connect in a repo",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/guides/provider-backed-knowledge",title:"Adopt provider-backed knowledge",description:"Ingest Gmail and Google Drive into governed knowledge spaces with persisted provider deltas and mutation gates.",section:"build",order:68,navTitle:"Provider-backed knowledge",primaryNav:!0,audience:"operator",ctaMode:"oss-next",aliases:["Gmail knowledge ingestion","Google Drive knowledge ingestion","ProviderDeltaSyncState"]},{href:"/docs/libraries",title:"Libraries overview",description:"Navigate the core libraries, runtimes, and system packages that make up the open foundation.",section:"build",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/data-views",title:"DataViews runtime",description:"Render list, grid, and table DataViews with shared collection defaults, toolbar controls, data depth, and personalization bridges.",section:"build",order:71,navTitle:"DataViews runtime",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["DataViewRenderer","dataDepth","collection view modes"]},{href:"/docs/libraries/personalization",title:"Personalization",description:"Track behavior events, resolve DataView preferences, and convert insights into overlays or workflow adaptations.",section:"build",order:72,navTitle:"Personalization",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["resolveDataViewPreferences","trackDataViewInteraction","data_view_interaction"]},{href:"/docs/libraries/translation-runtime",title:"Translation runtime",description:"Use ContractSpec TranslationSpec catalogs as the canonical i18n layer, then resolve, format, snapshot, and optionally project messages to i18next.",section:"build",order:73,navTitle:"Translation runtime",primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["i18n runtime","i18next adapter","translations"]},{href:"/docs/libraries/cross-platform-ui",title:"Cross-platform UI",description:"Understand how the presentation runtimes, ui-kit-web, ui-kit, and design-system stay aligned across React and React Native.",section:"build",order:74,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/application-shell",title:"Application shell",description:"Implement reusable app navigation with desktop sidebars, topbar breadcrumbs, command search, in-app notifications, mobile adapters, and PageOutline section navigation.",section:"build",order:75,audience:"oss",ctaMode:"oss-next"},{href:"/docs/libraries/design-system",title:"Design system",description:"Adopt high-level product UI primitives, actionable object references, responsive AdaptivePanel overlays, forms, data tables, and theme helpers.",section:"build",order:76,primaryNav:!0,audience:"oss",ctaMode:"oss-next",aliases:["object references","ObjectReferenceHandler","AdaptivePanel","adaptive panels","sheet drawer"]},{href:"/docs/architecture",title:"Architecture",description:"See how the spec layer, runtimes, integrations, and multi-surface outputs fit together.",section:"build",order:80,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/safety",title:"Operate safely",description:"Add auditability, migrations, policy controls, and trustworthy release behavior from the start.",section:"operate",order:10,navTitle:"Safety overview",primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/guides/ci-contract-diff-gating",title:"CI diff gating",description:"Use deterministic checks to block drift and risky changes before they reach production.",section:"operate",order:20,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/guides/release-capsules",title:"Author release capsules",description:"Pair changesets with structured release capsules, generate release artifacts, and keep changelog plus docs surfaces aligned.",section:"operate",order:25,navTitle:"Release capsules",primaryNav:!0,audience:"operator",ctaMode:"reference"},{href:"/docs/safety/security-trust",title:"Security and trust",description:"Understand the trust model, artifact validation expectations, and operational boundaries.",section:"operate",order:30,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/auditing",title:"Audit trails",description:"Track changes, policy decisions, and operational actions with a clear evidence trail.",section:"operate",order:40,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/migrations",title:"Migrations",description:"Evolve schemas and data safely without abandoning the contract layer.",section:"operate",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/safety/tenant-isolation",title:"Tenant isolation",description:"Keep tenant data, config, policies, and integrations separated at runtime.",section:"operate",order:60,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/knowledge",title:"Knowledge and context",description:"Bind trusted knowledge sources to the system without losing governance or isolation.",section:"operate",order:70,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/knowledge/governance",title:"Knowledge mutation governance",description:"Gate provider-backed knowledge mutations with dry-runs, approvals, idempotency, audit evidence, and outbound-send policy.",section:"operate",order:72,navTitle:"Knowledge governance",primaryNav:!0,audience:"operator",ctaMode:"oss-next",aliases:["knowledge.mutation.evaluateGovernance","KnowledgeMutationGovernance","outbound-send gates"]},{href:"/docs/advanced/telemetry",title:"Telemetry",description:"Instrument surfaces, collect evidence, and keep observability aligned with the contract model.",section:"operate",order:80,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/advanced/workflow-monitoring",title:"Workflow monitoring",description:"Observe multi-step execution with enough context to understand failures and regressions.",section:"operate",order:90,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/ops/distributed-tracing",title:"Distributed tracing",description:"Trace contract execution across integrations, workflows, and generated surfaces.",section:"operate",order:100,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/integrations",title:"Integrations overview",description:"Understand the binding model for external services, providers, and tenant-owned connections.",section:"integrations",order:10,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/spec-model",title:"Integration spec model",description:"Define what an integration provides before wiring it into an app or runtime.",section:"integrations",order:20,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/openai",title:"OpenAI integration",description:"Connect OpenAI through typed capabilities, explicit provider config, and governed runtime usage.",section:"integrations",order:30,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/mistral",title:"Mistral integration",description:"Use Mistral through the same provider contract model and runtime guardrails.",section:"integrations",order:40,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/qdrant",title:"Qdrant integration",description:"Store and retrieve knowledge embeddings with explicit provider configuration and ownership.",section:"integrations",order:50,primaryNav:!0,audience:"operator",ctaMode:"oss-next"},{href:"/docs/integrations/gmail",title:"Gmail integration",description:"Ingest email threads through delta-aware provider contracts and governed outbound-send mutations.",section:"integrations",order:55,primaryNav:!0,audience:"operator",ctaMode:"oss-next",aliases:["email knowledge ingestion","Gmail delta sync"]},{href:"/docs/integrations/google-drive",title:"Google Drive integration",description:"Ingest Drive files and watches through explicit cursor, webhook, replay, dedupe, and tombstone contracts.",section:"integrations",order:56,primaryNav:!0,audience:"operator",ctaMode:"oss-next",aliases:["Drive knowledge ingestion","Google Drive watchChanges","ProviderDeltaSyncState"]},{href:"/docs/integrations/stripe",title:"Stripe integration",description:"Bind payments and billing behavior without smearing provider logic across the codebase.",section:"integrations",order:60,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/twilio",title:"Twilio integration",description:"Handle messaging and telephony through typed transport boundaries and explicit configuration.",section:"integrations",order:70,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/integrations/github",title:"GitHub integration",description:"Push execution context into GitHub workflows and automation surfaces without hidden glue.",section:"integrations",order:80,primaryNav:!0,audience:"oss",ctaMode:"oss-next"},{href:"/docs/reference",title:"Contract reference",description:"Browse the generated reference index for public contract surfaces, versions, and examples.",section:"reference",order:10,primaryNav:!0,audience:"reference",ctaMode:"reference"},{href:"/docs/examples",title:"Examples",description:"Explore runnable examples and use them as reference implementations for new systems.",section:"reference",order:20,primaryNav:!0,audience:"reference",ctaMode:"reference"},{href:"/docs/studio",title:"Studio overview",description:"See what Studio adds on top of OSS ContractSpec and when a team should adopt the operating layer.",section:"studio",order:10,primaryNav:!0,audience:"studio-bridge",ctaMode:"studio-bridge"},{href:"/docs/manifesto",title:"Manifesto",description:"Why ContractSpec is built as an open system, how incremental adoption works, and why Studio stays additive.",audience:"secondary"},{href:"/docs/intent/contract-first-api",title:"Contract-first API",description:"Use contracts as the durable source of truth for API behavior and generated surfaces.",audience:"secondary"},{href:"/docs/intent/spec-driven-development",title:"Spec-driven development",description:"See how explicit specs stabilize change across APIs, UI, data, and agent-facing surfaces.",audience:"secondary"},{href:"/docs/intent/deterministic-codegen",title:"Deterministic regeneration",description:"Understand safe regeneration, conflict boundaries, and why teams keep control of the output.",audience:"secondary"},{href:"/docs/intent/schema-validation-typescript",title:"Schema validation and TypeScript",description:"Keep schema, runtime validation, and TypeScript behavior aligned without duplicate work.",audience:"secondary"},{href:"/docs/intent/openapi-alternative",title:"OpenAPI alternative",description:"Compare a multi-surface contract system with API-only description tooling.",audience:"secondary"},{href:"/docs/intent/generate-client-from-schema",title:"Generate client from schema",description:"Generate client-facing artifacts from the same source that drives runtime behavior.",audience:"secondary"},{href:"/docs/comparison",title:"Comparison overview",description:"Compare ContractSpec with workflow engines, internal-tool builders, and enterprise orchestration products.",audience:"secondary"},{href:"/docs/comparison/workflow-engines",title:"Workflow engines",description:"Contrast a contract system with workflow-only orchestration approaches.",audience:"secondary"},{href:"/docs/comparison/internal-tool-builders",title:"Internal-tool builders",description:"Compare ContractSpec with builders that optimize for screens instead of durable system contracts.",audience:"secondary"},{href:"/docs/comparison/automation-platforms",title:"Automation platforms",description:"Compare automation-first tools with a system that owns explicit contracts and generated surfaces.",audience:"secondary"},{href:"/docs/comparison/windmill",title:"Windmill comparison",description:"Understand where Windmill fits and where ContractSpec solves a different class of system problem.",audience:"secondary"},{href:"/docs/comparison/enterprise-platforms",title:"Enterprise orchestrators",description:"Compare ContractSpec with enterprise platforms that centralize execution in a closed operating surface.",audience:"secondary"},{href:"/docs/ecosystem/templates",title:"Templates",description:"Use templates and starter systems as proof points and accelerators for OSS adoption.",audience:"secondary"},{href:"/docs/ecosystem/plugins",title:"Plugins",description:"Explore marketplace and editor integrations that support the OSS workflow.",audience:"secondary"},{href:"/docs/ecosystem/registry",title:"Registry",description:"Inspect registry and manifest concepts that help package reusable capability surfaces.",audience:"secondary"}];function h(e){return i.find((t)=>t.href===e)}function c(){return o.map((e)=>({...e,items:i.filter((t)=>t.section===e.key&&t.primaryNav).sort((t,r)=>(t.order??0)-(r.order??0))}))}function l(){return i.filter((e)=>e.primaryNav).sort((e,t)=>o.findIndex((r)=>r.key===e.section)-o.findIndex((r)=>r.key===t.section)||(e.order??0)-(t.order??0))}function g(e){let t=l(),r=t.findIndex((a)=>a.href===e);if(r<0)return{previous:null,next:null};return{previous:t[r-1]??null,next:t[r+1]??null}}function f(){return i.filter((e)=>e.audience==="secondary")}function y(){return c().map((e)=>({...e,featured:e.items.slice(0,3)}))}export{f as getSecondaryDocsPages,l as getPrimaryDocsTraversal,c as getPrimaryDocsSections,h as getDocsPageByHref,g as getDocsNextPrevious,y as getDocsHomeSections,o as DOCS_PRIMARY_SECTIONS,i as DOCS_PAGES};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function GuideProviderBackedKnowledgePage(): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
// @bun
|
|
2
|
+
var d=Object.defineProperty;var s=(t)=>t;function c(t,a){this[t]=s.bind(null,a)}var u=(t,a)=>{for(var r in a)d(t,r,{get:a[r],enumerable:!0,configurable:!0,set:c.bind(a,r)})};var m=(t,a)=>()=>(t&&(a=t(t=0)),a);import{CodeBlock as n}from"@contractspec/lib.design-system";import i from"@contractspec/lib.ui-link";import{ChevronRight as l}from"lucide-react";import{jsx as e,jsxs as o}from"react/jsx-runtime";var p=["ProviderDeltaSyncState persisted for each source after sync or watch renewal.","Tombstoned provider records are skipped before indexing or mutation.","Outbound mutations carry dry-run, approval, idempotency, audit, and send-gate evidence.","Connect adoption resolves existing knowledge and integration surfaces before new runtime code is added."];function w(){return o("div",{className:"space-y-8",children:[o("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Adopt provider-backed knowledge"}),e("p",{className:"text-lg text-muted-foreground",children:"Turn Gmail and Google Drive into queryable knowledge without hiding provider state, webhook expiry, or mutation risk in background jobs. The contract layer models the source, the integration layer models provider deltas, and the knowledge runtime owns ingestion/query orchestration."})]}),o("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),o("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"Gmail and Drive sources bound to explicit knowledge spaces."}),e("li",{children:"A checkpoint store for leases, cursors, webhook channel expiry, and replay evidence."}),e("li",{children:"A mutation gate that blocks unsafe external sends or provider writes."}),e("li",{children:"Connect adoption evidence proving you reused the existing ContractSpec surfaces before adding custom provider code."})]})]}),o("div",{className:"space-y-6",children:[o("section",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Start from specs and sources"}),e("p",{className:"text-muted-foreground text-sm",children:"Define the knowledge space and source binding before runtime sync. Provider credentials stay in integration connections; source config stores only identity, scope, and replayable sync state."}),e(n,{language:"typescript",filename:"knowledge-source.ts",code:`const source = {
|
|
3
|
+
meta: {
|
|
4
|
+
id: "src_drive_support",
|
|
5
|
+
tenantId: "tenant-acme",
|
|
6
|
+
integrationConnectionId: "conn_google_drive",
|
|
7
|
+
spaceKey: "knowledge.support-faq",
|
|
8
|
+
spaceVersion: "1.0.0",
|
|
9
|
+
label: "Support Drive",
|
|
10
|
+
sourceType: "google_drive",
|
|
11
|
+
createdAt: new Date(),
|
|
12
|
+
updatedAt: new Date(),
|
|
13
|
+
},
|
|
14
|
+
syncState: {
|
|
15
|
+
cursorId: "drive-start-page-token",
|
|
16
|
+
watermarkVersion: "drive-v1",
|
|
17
|
+
lease: {
|
|
18
|
+
holder: "knowledge-sync-worker",
|
|
19
|
+
expiresAt: new Date(Date.now() + 5 * 60_000),
|
|
20
|
+
renewalWindowMs: 60_000,
|
|
21
|
+
},
|
|
22
|
+
},
|
|
23
|
+
config: {
|
|
24
|
+
query: "mimeType = 'text/plain' and trashed = false",
|
|
25
|
+
},
|
|
26
|
+
};`})]}),o("section",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Sync with checkpoints, not blind polling"}),e("p",{className:"text-muted-foreground text-sm",children:"`KnowledgeRuntime` can load a stored provider delta before listing Gmail or Drive, then save the next checkpoint after indexing. The store can be a database table, workflow state, or Connect-backed replay artifact."}),e(n,{language:"typescript",filename:"knowledge-runtime.ts",code:`const knowledge = createKnowledgeRuntime({
|
|
27
|
+
collection: "knowledge-support",
|
|
28
|
+
namespace: "tenant-acme",
|
|
29
|
+
embeddings,
|
|
30
|
+
vectorStore,
|
|
31
|
+
gmail,
|
|
32
|
+
drive,
|
|
33
|
+
deltaCheckpointStore,
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
await knowledge.syncGmail(
|
|
37
|
+
{ label: "support" },
|
|
38
|
+
{ sourceId: "src_gmail_support", evidenceRef: "audit://sync/gmail" },
|
|
39
|
+
);
|
|
40
|
+
|
|
41
|
+
await knowledge.syncDriveFiles(
|
|
42
|
+
{ query: "mimeType = 'text/plain' and trashed = false" },
|
|
43
|
+
{ sourceId: "src_drive_support", evidenceRef: "audit://sync/drive" },
|
|
44
|
+
);
|
|
45
|
+
|
|
46
|
+
await knowledge.watchDriveChanges(
|
|
47
|
+
{
|
|
48
|
+
channelId: "drive-watch-support",
|
|
49
|
+
webhookUrl: "https://app.example.com/webhooks/google-drive",
|
|
50
|
+
},
|
|
51
|
+
{ sourceId: "src_drive_support" },
|
|
52
|
+
);`})]}),o("section",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Gate mutations before provider writes"}),e("p",{className:"text-muted-foreground text-sm",children:"External sends and provider mutations should produce a decision envelope whether they execute, block, or run as dry-run. Persist that envelope with the same audit trail as the provider checkpoint."}),e(n,{language:"typescript",filename:"governed-mutation.ts",code:`const result = await knowledge.runGovernedMutation(
|
|
53
|
+
{
|
|
54
|
+
operation: "gmail.message.send",
|
|
55
|
+
sourceId: "src_gmail_support",
|
|
56
|
+
requiresApproval: true,
|
|
57
|
+
outboundSend: true,
|
|
58
|
+
governance: {
|
|
59
|
+
idempotencyKey: "tenant:gmail-send:123",
|
|
60
|
+
auditEvidence: { evidenceRef: "audit://gmail-send/123" },
|
|
61
|
+
approvalRefs: [{ id: "approval-123" }],
|
|
62
|
+
outboundSendGate: {
|
|
63
|
+
status: "approved",
|
|
64
|
+
evidenceRef: "gate://gmail-send/123",
|
|
65
|
+
},
|
|
66
|
+
},
|
|
67
|
+
},
|
|
68
|
+
() => gmail.sendEmail(message),
|
|
69
|
+
{ audit: (envelope) => auditTrail.write(envelope) },
|
|
70
|
+
);`})]}),o("section",{className:"card-subtle space-y-3 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"4) Adoption evidence"}),e("ul",{className:"space-y-2 text-muted-foreground text-sm",children:p.map((t)=>e("li",{children:t},t))}),e(n,{language:"bash",filename:"connect-adoption",code:`contractspec connect adoption sync --json
|
|
71
|
+
|
|
72
|
+
printf '{"goal":"Wire provider-backed knowledge for Gmail and Drive"}' | \\
|
|
73
|
+
contractspec connect adoption resolve --family knowledge --stdin --json`})]})]}),o("div",{className:"flex items-center gap-4 pt-4",children:[e(i,{href:"/docs/knowledge/sources",className:"btn-ghost",children:"Knowledge sources"}),o(i,{href:"/docs/integrations/google-drive",className:"btn-primary",children:["Google Drive integration ",e(l,{size:16})]})]})]})}export{w as GuideProviderBackedKnowledgePage};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
var N=Object.defineProperty;var O=(q)=>q;function Q(q,z){this[q]=O.bind(null,z)}var G=(q,z)=>{for(var F in z)N(q,F,{get:z[F],enumerable:!0,configurable:!0,set:Q.bind(z,F)})};var R=(q,z)=>()=>(q&&(z=q(q=0)),z);import{CodeBlock as U}from"@contractspec/lib.design-system";import{HStack as J,VStack as E}from"@contractspec/lib.design-system/layout";import{List as W,ListItem as K}from"@contractspec/lib.design-system/list";import{H1 as X,H2 as Y,P as M,Text as D}from"@contractspec/lib.design-system/typography";import Z from"@contractspec/lib.ui-link";import{ArrowRight as _,CheckCircle2 as $,GitBranch as w}from"lucide-react";import{jsx as f,jsxs as v}from"react/jsx-runtime";var A=[{title:"Adopt one endpoint in Next.js",description:"Start inside a live app with one operation, one generated surface, and one clearly bounded change.",href:"/docs/guides/nextjs-one-endpoint",time:"25 min"},{title:"Import an existing codebase",description:"Stabilize what already exists instead of treating adoption as a rewrite project.",href:"/docs/guides/import-existing-codebases",time:"20 min"},{title:"Validation and typing",description:"Keep runtime validation and TypeScript behavior aligned from the same source definitions.",href:"/docs/guides/spec-validation-and-typing",time:"20 min"},{title:"Build a contract-driven form",description:"Use FormSpec to keep data shape, fields, layout, policy, and submit behavior aligned.",href:"/docs/guides/contract-driven-forms",time:"25 min"},{title:"Flexible import templates",description:"Accept partner CSV, JSON, and XML files with alternate headers and localized values while preserving a canonical import contract.",href:"/docs/guides/data-exchange-import-templates",time:"25 min"},{title:"Generate docs and clients",description:"Publish stable docs, schemas, and client-facing artifacts from the contract layer.",href:"/docs/guides/generate-docs-clients-schemas",time:"20 min"},{title:"Docs pipeline",description:"Feed generated reference material into the docs site without confusing ownership.",href:"/docs/guides/docs-generation-pipeline",time:"20 min"},{title:"Build a first module bundle",description:"Define one bundle spec, resolve a surface plan, and render it through the React host layer.",href:"/docs/guides/first-module-bundle",time:"20 min"},{title:"Host the Builder workbench",description:"Wire a Builder workspace snapshot, common commands, runtime modes, and mobile review links into the reusable host.",href:"/docs/guides/host-builder-workbench",time:"20 min"},{title:"Use Connect in a repo",description:"Enable Connect, verify agent actions locally, and inspect the resulting review and replay artifacts.",href:"/docs/guides/connect-in-a-repo",time:"15 min"},{title:"Author release capsules",description:"Pair changesets with structured release capsules and generate the artifacts that changelog and upgrade flows consume.",href:"/docs/guides/release-capsules",time:"15 min"},{title:"CI diff gating",description:"Use deterministic checks to catch drift and risky changes before they ship.",href:"/docs/guides/ci-contract-diff-gating",time:"15 min"}];function p(){return v(E,{className:"space-y-10",children:[v(E,{className:"space-y-3",children:[f(D,{className:"editorial-kicker",children:"Build"}),f(X,{className:"font-serif text-4xl tracking-[-0.04em] md:text-5xl",children:"Adoption guides for teams that want to keep their code."}),f(M,{className:"max-w-3xl text-lg text-muted-foreground leading-8",children:"These guides assume you are introducing ContractSpec into a real code base. Start with a narrow surface, verify the generated outputs, and expand only after the contract loop feels trustworthy."})]}),f(E,{className:"grid gap-4 md:grid-cols-2",children:A.map((q)=>v(Z,{href:q.href,className:"editorial-panel",children:[v(J,{className:"flex items-start justify-between gap-4",children:[v(E,{children:[f(Y,{className:"font-semibold text-xl",children:q.title}),f(M,{className:"mt-2 text-muted-foreground text-sm leading-7",children:q.description})]}),f(_,{className:"mt-1 shrink-0",size:18})]}),v(J,{className:"mt-4 flex items-center gap-2 text-muted-foreground text-xs",children:[f($,{size:14}),v(D,{children:["Target time: ",q.time]})]})]},q.href))}),v(E,{className:"editorial-panel space-y-4",children:[v(J,{className:"flex items-center gap-2 font-semibold text-[color:var(--rust)] text-sm uppercase tracking-[0.2em]",children:[f(w,{size:16}),f(D,{children:"Working style"})]}),v(W,{className:"editorial-list",children:[f(K,{children:f(D,{children:"Run each guide in a branch or sandboxed workspace."})}),f(K,{children:f(D,{children:"Prefer one bounded surface at a time: one endpoint, one workflow, one integration, one unsafe module."})}),f(K,{children:f(D,{children:"Use the example and reference outputs to verify what changed, not just the narrative page."})})]}),f(U,{language:"bash",filename:"guides-quickstart",code:`# list example systems
|
|
2
|
+
var N=Object.defineProperty;var O=(q)=>q;function Q(q,z){this[q]=O.bind(null,z)}var G=(q,z)=>{for(var F in z)N(q,F,{get:z[F],enumerable:!0,configurable:!0,set:Q.bind(z,F)})};var R=(q,z)=>()=>(q&&(z=q(q=0)),z);import{CodeBlock as U}from"@contractspec/lib.design-system";import{HStack as J,VStack as E}from"@contractspec/lib.design-system/layout";import{List as W,ListItem as K}from"@contractspec/lib.design-system/list";import{H1 as X,H2 as Y,P as M,Text as D}from"@contractspec/lib.design-system/typography";import Z from"@contractspec/lib.ui-link";import{ArrowRight as _,CheckCircle2 as $,GitBranch as w}from"lucide-react";import{jsx as f,jsxs as v}from"react/jsx-runtime";var A=[{title:"Adopt one endpoint in Next.js",description:"Start inside a live app with one operation, one generated surface, and one clearly bounded change.",href:"/docs/guides/nextjs-one-endpoint",time:"25 min"},{title:"Import an existing codebase",description:"Stabilize what already exists instead of treating adoption as a rewrite project.",href:"/docs/guides/import-existing-codebases",time:"20 min"},{title:"Validation and typing",description:"Keep runtime validation and TypeScript behavior aligned from the same source definitions.",href:"/docs/guides/spec-validation-and-typing",time:"20 min"},{title:"Build a contract-driven form",description:"Use FormSpec to keep data shape, fields, layout, policy, and submit behavior aligned.",href:"/docs/guides/contract-driven-forms",time:"25 min"},{title:"Flexible import templates",description:"Accept partner CSV, JSON, and XML files with alternate headers and localized values while preserving a canonical import contract.",href:"/docs/guides/data-exchange-import-templates",time:"25 min"},{title:"Generate docs and clients",description:"Publish stable docs, schemas, and client-facing artifacts from the contract layer.",href:"/docs/guides/generate-docs-clients-schemas",time:"20 min"},{title:"Docs pipeline",description:"Feed generated reference material into the docs site without confusing ownership.",href:"/docs/guides/docs-generation-pipeline",time:"20 min"},{title:"Build a first module bundle",description:"Define one bundle spec, resolve a surface plan, and render it through the React host layer.",href:"/docs/guides/first-module-bundle",time:"20 min"},{title:"Host the Builder workbench",description:"Wire a Builder workspace snapshot, common commands, runtime modes, and mobile review links into the reusable host.",href:"/docs/guides/host-builder-workbench",time:"20 min"},{title:"Use Connect in a repo",description:"Enable Connect, verify agent actions locally, and inspect the resulting review and replay artifacts.",href:"/docs/guides/connect-in-a-repo",time:"15 min"},{title:"Adopt provider-backed knowledge",description:"Sync Gmail and Google Drive into governed knowledge spaces with provider checkpoints, tombstones, and mutation gates.",href:"/docs/guides/provider-backed-knowledge",time:"30 min"},{title:"Author release capsules",description:"Pair changesets with structured release capsules and generate the artifacts that changelog and upgrade flows consume.",href:"/docs/guides/release-capsules",time:"15 min"},{title:"CI diff gating",description:"Use deterministic checks to catch drift and risky changes before they ship.",href:"/docs/guides/ci-contract-diff-gating",time:"15 min"}];function p(){return v(E,{className:"space-y-10",children:[v(E,{className:"space-y-3",children:[f(D,{className:"editorial-kicker",children:"Build"}),f(X,{className:"font-serif text-4xl tracking-[-0.04em] md:text-5xl",children:"Adoption guides for teams that want to keep their code."}),f(M,{className:"max-w-3xl text-lg text-muted-foreground leading-8",children:"These guides assume you are introducing ContractSpec into a real code base. Start with a narrow surface, verify the generated outputs, and expand only after the contract loop feels trustworthy."})]}),f(E,{className:"grid gap-4 md:grid-cols-2",children:A.map((q)=>v(Z,{href:q.href,className:"editorial-panel",children:[v(J,{className:"flex items-start justify-between gap-4",children:[v(E,{children:[f(Y,{className:"font-semibold text-xl",children:q.title}),f(M,{className:"mt-2 text-muted-foreground text-sm leading-7",children:q.description})]}),f(_,{className:"mt-1 shrink-0",size:18})]}),v(J,{className:"mt-4 flex items-center gap-2 text-muted-foreground text-xs",children:[f($,{size:14}),v(D,{children:["Target time: ",q.time]})]})]},q.href))}),v(E,{className:"editorial-panel space-y-4",children:[v(J,{className:"flex items-center gap-2 font-semibold text-[color:var(--rust)] text-sm uppercase tracking-[0.2em]",children:[f(w,{size:16}),f(D,{children:"Working style"})]}),v(W,{className:"editorial-list",children:[f(K,{children:f(D,{children:"Run each guide in a branch or sandboxed workspace."})}),f(K,{children:f(D,{children:"Prefer one bounded surface at a time: one endpoint, one workflow, one integration, one unsafe module."})}),f(K,{children:f(D,{children:"Use the example and reference outputs to verify what changed, not just the narrative page."})})]}),f(U,{language:"bash",filename:"guides-quickstart",code:`# list example systems
|
|
3
3
|
contractspec examples list
|
|
4
4
|
|
|
5
5
|
# validate the examples in this workspace
|
|
@@ -47,4 +47,13 @@ bun docs:generate -- --version v1.0.0
|
|
|
47
47
|
|
|
48
48
|
Use the generated manifest and chunks under \`docs-index.manifest.json\` and \`docs-index.*.json\` to load the index at runtime.`},{id:"docs.guides.ci-contract-diff-gating",title:"CI gating for contract diffs",summary:"Gate changes with deterministic diffs and CI checks.",kind:"usage",visibility:"public",route:"/docs/guides/ci-contract-diff-gating",tags:["guides","ci","diff"],body:`# CI gating with deterministic diffs
|
|
49
49
|
|
|
50
|
-
Run ContractSpec CI checks to detect drift and breaking changes before merge.`}]
|
|
50
|
+
Run ContractSpec CI checks to detect drift and breaking changes before merge.`},{id:"docs.guides.provider-backed-knowledge",title:"Adopt provider-backed knowledge",summary:"Ingest Gmail and Google Drive with persisted deltas, replay checkpoints, tombstones, and mutation governance.",kind:"usage",visibility:"public",route:"/docs/guides/provider-backed-knowledge",tags:["guides","knowledge","integrations","governance"],body:`# Adopt provider-backed knowledge
|
|
51
|
+
|
|
52
|
+
Use \`@contractspec/lib.knowledge\` with Gmail and Google Drive providers to sync external knowledge through explicit \`ProviderDeltaSyncState\` checkpoints.
|
|
53
|
+
|
|
54
|
+
## Production baseline
|
|
55
|
+
|
|
56
|
+
- Persist provider cursor, watermark, webhook, replay, dedupe, idempotency, and tombstone state per source.
|
|
57
|
+
- Register \`knowledge.mutation.evaluateGovernance\` for mutation approval and audit evidence.
|
|
58
|
+
- Gate outbound sends and provider mutations through dry-run, approval, idempotency, and audit checks.
|
|
59
|
+
- Keep Connect review packets tied to the provider source and mutation evidence refs.`}];f(h);
|
|
@@ -10,6 +10,7 @@ export { GuideGenerateDocsClientsSchemasPage } from './GuideGenerateDocsClientsS
|
|
|
10
10
|
export { GuideHostBuilderWorkbenchPage } from './GuideHostBuilderWorkbenchPage';
|
|
11
11
|
export { GuideImportExistingCodebasesPage } from './GuideImportExistingCodebasesPage';
|
|
12
12
|
export { GuideNextjsOneEndpointPage } from './GuideNextjsOneEndpointPage';
|
|
13
|
+
export { GuideProviderBackedKnowledgePage } from './GuideProviderBackedKnowledgePage';
|
|
13
14
|
export { GuideReleaseCapsulesPage } from './GuideReleaseCapsulesPage';
|
|
14
15
|
export { GuideSpecValidationTypingPage } from './GuideSpecValidationTypingPage';
|
|
15
16
|
export { GuidesIndexPage } from './GuidesIndexPage';
|