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.publish

Publish generated documentation artifacts.

  • Type: operation (command)
  • Version: 1.0.0
  • Tags: publish
  • File: packages/libs/contracts-spec/src/docs/commands/docsPublish.command.ts
  • Deploy docs to the public docs surface with consistent versioning.

    field.key.label
    docs.publish
    field.version.label
    1.0.0
    field.type.label
    operation (command)
    field.title.label
    docs.publish
    field.description.label

    Publish generated documentation artifacts.

  • Type: operation (command)
  • Version: 1.0.0
  • Tags: publish
  • File: packages/libs/contracts-spec/src/docs/commands/docsPublish.command.ts
  • Deploy docs to the public docs surface with consistent versioning.

    field.tags.label
    publish
    field.owners.label
    field.stability.label

    Publish generated documentation artifacts.

    Goal

    Deploy docs to the public docs surface with consistent versioning.

    Context

    Used by release pipelines to push generated docs to hosting targets.

    Source Definition

    export const DocsPublishCommand = defineCommand({
      meta: {
        key: 'docs.publish',
        title: 'Publish Documentation',
        version: '1.0.0',
        description: 'Publish generated documentation artifacts.',
        goal: 'Deploy docs to the public docs surface with consistent versioning.',
        context:
          'Used by release pipelines to push generated docs to hosting targets.',
        domain: DOCS_DOMAIN,
        owners: DOCS_OWNERS,
        tags: [...DOCS_TAGS, 'publish'],
        stability: DOCS_STABILITY,
        docId: [docId('docs.tech.docs-publish')],
      },
      capability: {
        key: 'docs.system',
        version: '1.0.0',
      },
      io: {
        input: DocsPublishInput,
        output: DocsPublishOutput,
        errors: {
          DEPLOY_FAILED: {
            description: 'Failed to deploy documentation artifacts.',
            http: 500,
            when: 'The docs publish step fails to deploy to the target host.',
          },
        },
      },
      policy: {
        auth: 'admin',
        pii: [],
      },
      sideEffects: {
        emits: [
          {
            ref: DocsPublishedEvent.meta,
            when: 'Docs publish completes successfully.',
          },
        ],
      },
    });