ContractSpec docs

OSS-first docs

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

learning-journey-studio-onboarding

Studio onboarding journey for getting started with ContractSpec Studio

  • Type: feature
  • Version: 1.0.0
  • Stability: experimental
  • Owners: @examples.learning-journey.studio-onboarding
  • Tags: learning, onboarding, studio, journey
  • field.key.label
    learning-journey-studio-onboarding
    field.version.label
    1.0.0
    field.type.label
    feature
    field.title.label
    learning-journey-studio-onboarding
    field.description.label

    Studio onboarding journey for getting started with ContractSpec Studio

  • Type: feature
  • Version: 1.0.0
  • Stability: experimental
  • Owners: @examples.learning-journey.studio-onboarding
  • Tags: learning, onboarding, studio, journey
  • field.tags.label
    learning,onboarding,studio,journey
    field.owners.label
    @examples.learning-journey.studio-onboarding
    field.stability.label
    experimental

    Studio onboarding journey for getting started with ContractSpec Studio

    Operations (2)

    `learningJourney.studioOnboarding.recordEvent` (v1.0.0)

    `learningJourney.studioOnboarding.getTrack` (v1.0.0)

    Presentations (2)

    `learning.journey.studio.track` (v1.0.0)

    `learning.journey.studio.widget` (v1.0.0)

    Source Definition

    /**
     * Learning Journey Studio Onboarding Feature Module Specification
     *
     * Defines the feature module for Studio onboarding journey.
     */
    import { defineFeature } from '@lssm-tech/lib.contracts-spec';
    
    /**
     * Learning Journey Studio Onboarding feature module that bundles
     * Studio-specific onboarding track operations and presentations.
     */
    export const LearningJourneyStudioOnboardingFeature = defineFeature({
    	meta: {
    		key: 'learning-journey-studio-onboarding',
    		title: 'Learning Journey: Studio Onboarding',
    		description:
    			'Studio onboarding journey for getting started with ContractSpec Studio',
    		domain: 'learning-journey',
    		owners: ['@examples.learning-journey.studio-onboarding'],
    		tags: ['learning', 'onboarding', 'studio', 'journey'],
    		stability: 'experimental',
    		version: '1.0.0',
    	},
    
    	// All contract operations included in this feature
    	operations: [
    		{ key: 'learningJourney.studioOnboarding.recordEvent', version: '1.0.0' },
    		{ key: 'learningJourney.studioOnboarding.getTrack', version: '1.0.0' },
    	],
    
    	// Events emitted by this feature
    	events: [],
    
    	// Presentations associated with this feature
    	presentations: [
    		{ key: 'learning.journey.studio.track', version: '1.0.0' },
    		{ key: 'learning.journey.studio.widget', version: '1.0.0' },
    	],
    
    	// Link operations to their primary presentations
    	opToPresentation: [
    		{
    			op: {
    				key: 'learningJourney.studioOnboarding.getTrack',
    				version: '1.0.0',
    			},
    			pres: { key: 'learning.journey.studio.track', version: '1.0.0' },
    		},
    	],
    
    	// Target requirements for multi-surface rendering
    	presentationsTargets: [
    		{
    			key: 'learning.journey.studio.track',
    			version: '1.0.0',
    			targets: ['react', 'markdown', 'application/json'],
    		},
    		{
    			key: 'learning.journey.studio.widget',
    			version: '1.0.0',
    			targets: ['react'],
    		},
    	],
    
    	// Capability requirements
    	capabilities: {
    		requires: [{ key: 'identity', version: '1.0.0' }],
    	},
    
    	docs: ['docs.learning-journey.studio-onboarding'],
    });