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_search

Search and filter DocBlocks by query, tag, or visibility.

  • Type: operation (query)
  • Version: 1.0.0
  • Tags: search, index
  • File: packages/libs/contracts-spec/src/docs/queries/docsIndex.query.ts
  • field.key.label
    docs_search
    field.version.label
    1.0.0
    field.type.label
    operation (query)
    field.title.label
    docs_search
    field.description.label

    Search and filter DocBlocks by query, tag, or visibility.

  • Type: operation (query)
  • Version: 1.0.0
  • Tags: search, index
  • File: packages/libs/contracts-spec/src/docs/queries/docsIndex.query.ts
  • field.tags.label
    search,index
    field.owners.label
    field.stability.label

    Search and filter DocBlocks by query, tag, or visibility.

    Goal

    Provide a consistent index of documentation entries for UI and MCP.

    Context

    Used by docs surfaces to list and filter DocBlocks without coupling to storage.

    Source Definition

    export const DocsIndexQuery = defineQuery({
      meta: {
        key: 'docs_search',
        title: 'Docs Index',
        version: '1.0.0',
        description: 'Search and filter DocBlocks by query, tag, or visibility.',
        goal: 'Provide a consistent index of documentation entries for UI and MCP.',
        context:
          'Used by docs surfaces to list and filter DocBlocks without coupling to storage.',
        domain: DOCS_DOMAIN,
        owners: DOCS_OWNERS,
        tags: [...DOCS_TAGS, 'search', 'index'],
        stability: DOCS_STABILITY,
        docId: [docId('docs.tech.docs-search')],
      },
      capability: {
        key: 'docs.system',
        version: '1.0.0',
      },
      io: {
        input: DocsIndexInput,
        output: DocsIndexOutput,
      },
      policy: {
        auth: 'anonymous',
        pii: [],
      },
    });