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.

AI index

in-app-docs

DocBlock-based in-app documentation viewer for non-technical users

  • Type: feature
  • Version: 1.0.0
  • Stability: experimental
  • Owners: @examples
  • Tags: docs, in-app, viewer
  • File: packages/examples/in-app-docs/src/in-app-docs.feature.ts

    • field.key.label
    in-app-docs
    field.version.label
    1.0.0
    field.type.label
    feature
    field.title.label
    in-app-docs
    field.description.label

    DocBlock-based in-app documentation viewer for non-technical users

  • Type: feature
  • Version: 1.0.0
  • Stability: experimental
  • Owners: @examples
  • Tags: docs, in-app, viewer
  • File: packages/examples/in-app-docs/src/in-app-docs.feature.ts

    • field.tags.label
    docs,in-app,viewer
    field.owners.label
    @examples
    field.stability.label
    experimental

    DocBlock-based in-app documentation viewer for non-technical users

    Source Definition

    import { defineFeature } from '@lssm-tech/lib.contracts-spec';

export const InAppDocsFeature = defineFeature({
	meta: {
		key: 'in-app-docs',
		version: '1.0.0',
		title: 'In-App Docs',
		description:
			'DocBlock-based in-app documentation viewer for non-technical users',
		domain: 'docs',
		owners: ['@examples'],
		tags: ['docs', 'in-app', 'viewer'],
		stability: 'experimental',
	},

	docs: ['docs.examples.in-app-docs', 'docs.examples.in-app-docs.usage'],
});