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.

docs.system

End-to-end docs generation, indexing, and presentation.

  • Type: capability (capability)
  • Version: 1.0.0
  • Tags: system
  • File: packages/libs/contracts-spec/src/docs/capabilities/documentationSystem.capability.ts
  • field.key.label
    docs.system
    field.version.label
    1.0.0
    field.type.label
    capability (capability)
    field.title.label
    docs.system
    field.description.label

    End-to-end docs generation, indexing, and presentation.

  • Type: capability (capability)
  • Version: 1.0.0
  • Tags: system
  • File: packages/libs/contracts-spec/src/docs/capabilities/documentationSystem.capability.ts
  • field.tags.label
    system
    field.owners.label
    field.stability.label

    End-to-end docs generation, indexing, and presentation.

    Source Definition

    import { defineCapability } from '../../capabilities';
    import {
    	DOCS_DOMAIN,
    	DOCS_OWNERS,
    	DOCS_STABILITY,
    	DOCS_TAGS,
    } from '../constants';
    
    export const DocumentationSystemCapability = defineCapability({
    	meta: {
    		key: 'docs.system',
    		version: '1.0.0',
    		kind: 'ui',
    		title: 'Documentation System',
    		description: 'End-to-end docs generation, indexing, and presentation.',
    		domain: DOCS_DOMAIN,
    		owners: DOCS_OWNERS,
    		tags: [...DOCS_TAGS, 'system'],
    		stability: DOCS_STABILITY,
    	},
    	provides: [
    		{
    			surface: 'operation',
    			key: 'docs.generate',
    			version: '1.0.0',
    			description: 'Generate documentation artifacts.',
    		},
    		{
    			surface: 'operation',
    			key: 'docs.publish',
    			version: '1.0.0',
    			description: 'Publish documentation artifacts.',
    		},
    		{
    			surface: 'operation',
    			key: 'docs_search',
    			version: '1.0.0',
    			description: 'Index and search DocBlocks.',
    		},
    		{
    			surface: 'operation',
    			key: 'docs.contract.reference',
    			version: '1.0.0',
    			description: 'Resolve contract references for docs.',
    		},
    		{
    			surface: 'event',
    			key: 'docs.generated',
    			version: '1.0.0',
    			description: 'Docs generation completed.',
    		},
    		{
    			surface: 'event',
    			key: 'docs.published',
    			version: '1.0.0',
    			description: 'Docs publish completed.',
    		},
    		{
    			surface: 'presentation',
    			key: 'docs.layout',
    			version: '1.0.0',
    			description: 'Docs layout presentation.',
    		},
    		{
    			surface: 'presentation',
    			key: 'docs.reference.page',
    			version: '1.0.0',
    			description: 'Docs reference page presentation.',
    		},
    	],
    });