feat(docs): generated bilingual Schema reference (L0 Core: EntitySet/DataSet/Link/Storage)

Makefile

@@ -1,4 +1,4 @@
-.PHONY: help check-env install-env setup setup-ui expand doc example-validate check-manifest
+.PHONY: help check-env install-env setup setup-ui expand doc docs-schema docs-schema-check example-validate check-manifest
 .PHONY: build build-service build-cli install-cli build-ui build-sdk-go dev quickstart dev-api dev-web deploy serve-ui status stop-all stop-dev stop-deploy test test-service test-ui test-ui-e2e test-capability test-quickstart-health test-ladybug verify verify-go verify-python verify-java guard ci clean
 
 VENV_PYTHON := .venv/bin/python
@@ -186,6 +186,12 @@ schemas-embed-check:
 doc:
 	@bash ./tools/converters/batch_convert_html.sh
 
+docs-schema:
+	@$(PYTHON) ./tools/docs/gen_schema_reference.py
+
+docs-schema-check:
+	@$(PYTHON) ./tools/docs/gen_schema_reference.py --check
+
 example-validate:
 	@$(PYTHON) ./tools/validators/umodel_validator.py --batch examples
 
@@ -206,7 +212,7 @@ test: guard test-service verify
 check-manifest:
 	@$(PYTHON) ./tools/verify/check_manifest.py
 
-ci: guard schemas-embed-check build-service test-service test-capability test-quickstart-health verify check-manifest example-validate
+ci: guard schemas-embed-check build-service test-service test-capability test-quickstart-health verify check-manifest example-validate docs-schema-check
 	@echo "Local CI passed."
 
 check-env:

docs/.vitepress/config/en.ts

@@ -1,4 +1,5 @@
 import type { LocaleSpecificConfig, DefaultTheme } from 'vitepress'
+import schemaSidebar from './schema-sidebar.json'
 
 const nav: DefaultTheme.NavItem[] = [
   { text: 'Guide', link: '/en/getting-started/quickstart', activeMatch: '/en/(getting-started|concepts|guides|architecture)/' },
@@ -67,6 +68,7 @@ const sidebar: DefaultTheme.SidebarItem[] = [
     items: [
       { text: 'CLI', link: '/en/reference/cli' },
       { text: 'MCP', link: '/en/reference/mcp' },
+      { text: 'Schema', link: '/en/reference/schema/' },
       { text: 'Web UI API Map', link: '/en/ui-api' },
       { text: 'UI Architecture', link: '/en/ui-architecture' },
       { text: 'SDK Specification', link: '/en/umodel-sdk-specification' },
@@ -81,13 +83,18 @@ const sidebar: DefaultTheme.SidebarItem[] = [
   },
 ]
 
+const schemaNav: DefaultTheme.SidebarItem[] = [
+  { text: 'Schema Reference', link: '/en/reference/schema/' },
+  ...(schemaSidebar.en as DefaultTheme.SidebarItem[]),
+]
+
 export const en: LocaleSpecificConfig<DefaultTheme.Config> & { label: string; link?: string } = {
   label: 'English',
   lang: 'en-US',
   link: '/en/',
   themeConfig: {
     nav,
-    sidebar: { '/en/': sidebar },
+    sidebar: { '/en/reference/schema/': schemaNav, '/en/': sidebar },
     outline: { level: [2, 3], label: 'On this page' },
     docFooter: { prev: 'Previous', next: 'Next' },
     editLink: {

docs/.vitepress/config/schema-sidebar.json

@@ -0,0 +1,246 @@
+{
+  "en": [
+    {
+      "text": "EntitySet",
+      "collapsed": false,
+      "items": [
+        {
+          "text": "entity_set",
+          "link": "/en/reference/schema/core/entity-set"
+        }
+      ]
+    },
+    {
+      "text": "DataSet",
+      "collapsed": false,
+      "items": [
+        {
+          "text": "entity_source",
+          "link": "/en/reference/schema/core/dataset/entity-source"
+        },
+        {
+          "text": "event_set",
+          "link": "/en/reference/schema/core/dataset/event-set"
+        },
+        {
+          "text": "explorer",
+          "link": "/en/reference/schema/core/dataset/explorer"
+        },
+        {
+          "text": "log_set",
+          "link": "/en/reference/schema/core/dataset/log-set"
+        },
+        {
+          "text": "metric_set",
+          "link": "/en/reference/schema/core/dataset/metric-set"
+        },
+        {
+          "text": "profile_set",
+          "link": "/en/reference/schema/core/dataset/profile-set"
+        },
+        {
+          "text": "runbook_set",
+          "link": "/en/reference/schema/core/dataset/runbook-set"
+        },
+        {
+          "text": "trace_set",
+          "link": "/en/reference/schema/core/dataset/trace-set"
+        }
+      ]
+    },
+    {
+      "text": "Link",
+      "collapsed": false,
+      "items": [
+        {
+          "text": "data_link",
+          "link": "/en/reference/schema/core/link/data-link"
+        },
+        {
+          "text": "entity_set_link",
+          "link": "/en/reference/schema/core/link/entity-set-link"
+        },
+        {
+          "text": "entity_source_link",
+          "link": "/en/reference/schema/core/link/entity-source-link"
+        },
+        {
+          "text": "explorer_link",
+          "link": "/en/reference/schema/core/link/explorer-link"
+        },
+        {
+          "text": "runbook_link",
+          "link": "/en/reference/schema/core/link/runbook-link"
+        },
+        {
+          "text": "storage_link",
+          "link": "/en/reference/schema/core/link/storage-link"
+        }
+      ]
+    },
+    {
+      "text": "Storage",
+      "collapsed": false,
+      "items": [
+        {
+          "text": "aliyun_prometheus",
+          "link": "/en/reference/schema/core/storage/aliyun-prometheus"
+        },
+        {
+          "text": "elasticsearch",
+          "link": "/en/reference/schema/core/storage/elasticsearch"
+        },
+        {
+          "text": "external_storage",
+          "link": "/en/reference/schema/core/storage/external-storage"
+        },
+        {
+          "text": "mysql",
+          "link": "/en/reference/schema/core/storage/mysql"
+        },
+        {
+          "text": "prometheus",
+          "link": "/en/reference/schema/core/storage/prometheus"
+        },
+        {
+          "text": "sls_entitystore",
+          "link": "/en/reference/schema/core/storage/sls-entitystore"
+        },
+        {
+          "text": "sls_logstore",
+          "link": "/en/reference/schema/core/storage/sls-logstore"
+        },
+        {
+          "text": "sls_metricstore",
+          "link": "/en/reference/schema/core/storage/sls-metricstore"
+        }
+      ]
+    },
+    {
+      "text": "Shared types",
+      "link": "/en/reference/schema/shared-types"
+    }
+  ],
+  "zh": [
+    {
+      "text": "EntitySet（实体集）",
+      "collapsed": false,
+      "items": [
+        {
+          "text": "entity_set",
+          "link": "/zh/reference/schema/core/entity-set"
+        }
+      ]
+    },
+    {
+      "text": "DataSet（数据集）",
+      "collapsed": false,
+      "items": [
+        {
+          "text": "entity_source",
+          "link": "/zh/reference/schema/core/dataset/entity-source"
+        },
+        {
+          "text": "event_set",
+          "link": "/zh/reference/schema/core/dataset/event-set"
+        },
+        {
+          "text": "explorer",
+          "link": "/zh/reference/schema/core/dataset/explorer"
+        },
+        {
+          "text": "log_set",
+          "link": "/zh/reference/schema/core/dataset/log-set"
+        },
+        {
+          "text": "metric_set",
+          "link": "/zh/reference/schema/core/dataset/metric-set"
+        },
+        {
+          "text": "profile_set",
+          "link": "/zh/reference/schema/core/dataset/profile-set"
+        },
+        {
+          "text": "runbook_set",
+          "link": "/zh/reference/schema/core/dataset/runbook-set"
+        },
+        {
+          "text": "trace_set",
+          "link": "/zh/reference/schema/core/dataset/trace-set"
+        }
+      ]
+    },
+    {
+      "text": "Link（链接）",
+      "collapsed": false,
+      "items": [
+        {
+          "text": "data_link",
+          "link": "/zh/reference/schema/core/link/data-link"
+        },
+        {
+          "text": "entity_set_link",
+          "link": "/zh/reference/schema/core/link/entity-set-link"
+        },
+        {
+          "text": "entity_source_link",
+          "link": "/zh/reference/schema/core/link/entity-source-link"
+        },
+        {
+          "text": "explorer_link",
+          "link": "/zh/reference/schema/core/link/explorer-link"
+        },
+        {
+          "text": "runbook_link",
+          "link": "/zh/reference/schema/core/link/runbook-link"
+        },
+        {
+          "text": "storage_link",
+          "link": "/zh/reference/schema/core/link/storage-link"
+        }
+      ]
+    },
+    {
+      "text": "Storage（存储）",
+      "collapsed": false,
+      "items": [
+        {
+          "text": "aliyun_prometheus",
+          "link": "/zh/reference/schema/core/storage/aliyun-prometheus"
+        },
+        {
+          "text": "elasticsearch",
+          "link": "/zh/reference/schema/core/storage/elasticsearch"
+        },
+        {
+          "text": "external_storage",
+          "link": "/zh/reference/schema/core/storage/external-storage"
+        },
+        {
+          "text": "mysql",
+          "link": "/zh/reference/schema/core/storage/mysql"
+        },
+        {
+          "text": "prometheus",
+          "link": "/zh/reference/schema/core/storage/prometheus"
+        },
+        {
+          "text": "sls_entitystore",
+          "link": "/zh/reference/schema/core/storage/sls-entitystore"
+        },
+        {
+          "text": "sls_logstore",
+          "link": "/zh/reference/schema/core/storage/sls-logstore"
+        },
+        {
+          "text": "sls_metricstore",
+          "link": "/zh/reference/schema/core/storage/sls-metricstore"
+        }
+      ]
+    },
+    {
+      "text": "共享类型",
+      "link": "/zh/reference/schema/shared-types"
+    }
+  ]
+}

docs/.vitepress/config/zh.ts

@@ -1,4 +1,5 @@
 import type { LocaleSpecificConfig, DefaultTheme } from 'vitepress'
+import schemaSidebar from './schema-sidebar.json'
 
 const nav: DefaultTheme.NavItem[] = [
   { text: '指南', link: '/zh/getting-started/quickstart', activeMatch: '/zh/(getting-started|concepts|guides|architecture)/' },
@@ -67,6 +68,7 @@ const sidebar: DefaultTheme.SidebarItem[] = [
     items: [
       { text: 'CLI', link: '/zh/reference/cli' },
       { text: 'MCP', link: '/zh/reference/mcp' },
+      { text: 'Schema', link: '/zh/reference/schema/' },
       { text: 'Web UI API 映射', link: '/zh/ui-api' },
       { text: 'UI 架构', link: '/zh/ui-architecture' },
       { text: 'SDK 规范', link: '/zh/umodel-sdk-specification' },
@@ -81,13 +83,18 @@ const sidebar: DefaultTheme.SidebarItem[] = [
   },
 ]
 
+const schemaNav: DefaultTheme.SidebarItem[] = [
+  { text: 'Schema 参考', link: '/zh/reference/schema/' },
+  ...(schemaSidebar.zh as DefaultTheme.SidebarItem[]),
+]
+
 export const zh: LocaleSpecificConfig<DefaultTheme.Config> & { label: string; link?: string } = {
   label: '简体中文',
   lang: 'zh-CN',
   link: '/zh/',
   themeConfig: {
     nav,
-    sidebar: { '/zh/': sidebar },
+    sidebar: { '/zh/reference/schema/': schemaNav, '/zh/': sidebar },
     outline: { level: [2, 3], label: '本页目录' },
     docFooter: { prev: '上一页', next: '下一页' },
     editLink: {

docs/en/reference/schema/core/dataset/entity-source.md

@@ -0,0 +1,14 @@
+# entity_source
+
+EntitySource defines the import job for a specific entity and its source storage (e.g. SLS LogStore / MetricStore).
+
+**Kind**: `entity_source`
+
+> Every element shares the standard envelope `kind` · [metadata](../../shared-types#metadata) · [schema](../../shared-types#schema).
+
+## `spec` fields
+
+| Field | Type | Required | Default | Description |
+|---|---|---|---|---|
+| `constructor` | map<string, any> | yes |  | Constructor/scheduling configuration of the import job, supports flexible key-value pairs. |
+| `storages` | array<map> | yes |  | List of source storage configurations, each element is a map supporting flexible fields. |

docs/en/reference/schema/core/dataset/event-set.md

@@ -0,0 +1,18 @@
+# event_set
+
+EventSet is a collection of related events that share certain common attributes or characteristics.
+
+**Kind**: `event_set`
+
+> Every element shares the standard envelope `kind` · [metadata](../../shared-types#metadata) · [schema](../../shared-types#schema).
+
+**Inherits**: [telemetry_data](../../shared-types#telemetry_data)
+
+## `spec` fields
+
+| Field | Type | Required | Default | Description |
+|---|---|---|---|---|
+| `entity_fields` | object |  |  | Entity fields, used to identify the ID, domain and type of entity |
+| `entity_fields.entity_id` | `string` |  | `__entity_id__` | Entity ID field, used to identify the ID of entity |
+| `entity_fields.domain` | `string` |  | `__domain__` | Domain field which entity belongs to |
+| `entity_fields.entity_type` | `string` |  | `__entity_type__` | Entity type field, used to identify the type of entity |

docs/en/reference/schema/core/dataset/explorer.md

@@ -0,0 +1,13 @@
+# explorer
+
+**Kind**: `explorer`
+
+> Every element shares the standard envelope `kind` · [metadata](../../shared-types#metadata) · [schema](../../shared-types#schema).
+
+## `spec` fields
+
+| Field | Type | Required | Default | Description |
+|---|---|---|---|---|
+| `type` | `string` | yes |  | The kind of explorer. |
+| `query` | `string` |  |  | The default query of explorer. |
+| `config` | map<string, any> |  |  | The config dynamic of explorer. |