From f0e9267eca4ccedfcf66c2a9e1f95b65b4886e9c Mon Sep 17 00:00:00 2001 From: Jack Zhuang <277994282+os-zhuang@users.noreply.github.com> Date: Mon, 15 Jun 2026 09:06:56 +0500 Subject: [PATCH] docs(nav): group Protocol Reference modules and clarify top-level nav MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The docs site rendered fine but its information architecture was hard to navigate: 238 of 366 pages live under Protocol Reference, and each module was a single flat alphabetical list (system: 40, api: 38, kernel: 32, …). The top-level "Protocol" (5 pages) vs "Protocol Reference" (238 pages) split was also ambiguous. Navigation-only changes (no content edits, no file moves): - Add second-level `---section---` groups to the 8 largest reference modules (system, api, kernel, data, ui, cloud, automation, ai), turning each flat list into labeled logical groups. Smaller modules (≤9 pages) stay flat to avoid over-fragmenting short lists. - Rename top-level "Protocol" → "Protocol Overview" to distinguish the conceptual intro from the per-module "Protocol Reference". - Remove the empty, orphaned references/contracts/ folder. Every regrouped meta.json was validated: valid JSON, every existing .mdx covered, no dangling entries. Verified in the browser (grouped section headers render correctly, no build errors). Co-Authored-By: Claude Opus 4.8 (1M context) --- content/docs/protocol/meta.json | 2 +- content/docs/references/ai/meta.json | 15 +++-- content/docs/references/api/meta.json | 61 ++++++++++-------- content/docs/references/automation/meta.json | 23 ++++--- content/docs/references/cloud/meta.json | 15 +++-- content/docs/references/contracts/meta.json | 4 -- content/docs/references/data/meta.json | 36 ++++++----- content/docs/references/kernel/meta.json | 49 ++++++++------- content/docs/references/system/meta.json | 65 +++++++++++--------- content/docs/references/ui/meta.json | 34 +++++----- 10 files changed, 169 insertions(+), 135 deletions(-) delete mode 100644 content/docs/references/contracts/meta.json diff --git a/content/docs/protocol/meta.json b/content/docs/protocol/meta.json index a854b81641..64257e9e2d 100644 --- a/content/docs/protocol/meta.json +++ b/content/docs/protocol/meta.json @@ -1,4 +1,4 @@ { - "title": "Protocol", + "title": "Protocol Overview", "pages": ["index", "objectql", "objectui", "objectos", "knowledge"] } diff --git a/content/docs/references/ai/meta.json b/content/docs/references/ai/meta.json index 6f50bf15b1..bfca1c0399 100644 --- a/content/docs/references/ai/meta.json +++ b/content/docs/references/ai/meta.json @@ -1,16 +1,19 @@ { "title": "AI Protocol", "pages": [ + "---Agents & Tools---", "agent", + "tool", + "skill", "conversation", - "embedding", - "knowledge-document", - "knowledge-source", "mcp", + "---Knowledge & Embeddings---", + "knowledge-source", + "knowledge-document", + "embedding", + "---Models & Solutions---", "model-registry", - "skill", "solution-blueprint", - "tool", "usage" ] -} \ No newline at end of file +} diff --git a/content/docs/references/api/meta.json b/content/docs/references/api/meta.json index eefad9f2c8..0112841c9b 100644 --- a/content/docs/references/api/meta.json +++ b/content/docs/references/api/meta.json @@ -1,43 +1,50 @@ { "title": "API Protocol", "pages": [ - "analytics", - "auth", - "auth-endpoints", - "automation-api", - "batch", - "connector", - "contract", + "---Overview---", + "protocol", "core-services", - "discovery", - "dispatcher", "documentation", + "discovery", + "---REST & HTTP---", + "rest-server", + "router", "endpoint", - "errors", - "events", + "object", + "batch", "export", - "feed-api", - "graphql", "http", "http-cache", - "identity", + "errors", + "versioning", + "---Query Interfaces---", + "query-adapter", + "graphql", + "odata", + "analytics", "metadata", "metadata-plugin", + "contract", + "---Auth & Identity---", + "auth", + "auth-endpoints", + "identity", + "---Realtime & Events---", + "realtime", + "realtime-shared", + "websocket", + "events", + "dispatcher", "notification", - "object", - "odata", + "feed-api", + "---Automation & Integration---", + "automation-api", + "connector", + "plugin-rest-api", + "---Packages & Storage---", "package-api", "package-registry", - "plugin-rest-api", - "protocol", - "query-adapter", - "realtime", - "realtime-shared", "registry", - "rest-server", - "router", - "storage", - "versioning", - "websocket" + "storage" ] -} \ No newline at end of file +} diff --git a/content/docs/references/automation/meta.json b/content/docs/references/automation/meta.json index 986231e842..e78f68764d 100644 --- a/content/docs/references/automation/meta.json +++ b/content/docs/references/automation/meta.json @@ -1,18 +1,21 @@ { "title": "Automation Protocol", "pages": [ - "approval", - "bpmn-interop", - "connector", - "etl", - "execution", + "---Flows & Execution---", "flow", - "job", + "execution", "node-executor", - "offline", "state-machine", - "sync", + "bpmn-interop", + "---Triggers & Jobs---", "trigger-registry", - "webhook" + "job", + "webhook", + "offline", + "---Workflows & Integration---", + "approval", + "etl", + "sync", + "connector" ] -} \ No newline at end of file +} diff --git a/content/docs/references/cloud/meta.json b/content/docs/references/cloud/meta.json index 4c7825db1d..ea01b47818 100644 --- a/content/docs/references/cloud/meta.json +++ b/content/docs/references/cloud/meta.json @@ -1,18 +1,21 @@ { "title": "Cloud Protocol", "pages": [ - "app-store", - "developer-portal", + "---Environments---", "environment", "environment-artifact", "environment-package", + "provisioning", + "tenant", + "---Marketplace & Distribution---", "marketplace", "marketplace-admin", + "app-store", + "developer-portal", + "---Packages---", "package", "package-version", - "plugin-security", - "provisioning", "template-manifest", - "tenant" + "plugin-security" ] -} \ No newline at end of file +} diff --git a/content/docs/references/contracts/meta.json b/content/docs/references/contracts/meta.json deleted file mode 100644 index 532dffd336..0000000000 --- a/content/docs/references/contracts/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "title": "Contracts Protocol", - "pages": [] -} \ No newline at end of file diff --git a/content/docs/references/data/meta.json b/content/docs/references/data/meta.json index e6a34a191d..2ce5a37e86 100644 --- a/content/docs/references/data/meta.json +++ b/content/docs/references/data/meta.json @@ -1,29 +1,35 @@ { "title": "Data Protocol", "pages": [ + "---Core Modeling---", + "object", + "field", + "validation", + "mapping", + "document", + "---Query & Filter---", + "query", + "filter", + "date-macros", "analytics", + "---Engine & Drivers---", "data-engine", "datasource", - "date-macros", - "document", "driver", - "driver-nosql", "driver-sql", - "external-catalog", - "external-lookup", - "feed", - "field", - "filter", + "driver-nosql", + "---Hooks & Lifecycle---", "hook", "hook-body", - "mapping", + "subscription", + "feed", "notification", - "object", - "query", + "---External Data---", + "external-catalog", + "external-lookup", "search-engine", + "---Seeding---", "seed", - "seed-loader", - "subscription", - "validation" + "seed-loader" ] -} \ No newline at end of file +} diff --git a/content/docs/references/kernel/meta.json b/content/docs/references/kernel/meta.json index cef12715f1..6f3f8bb249 100644 --- a/content/docs/references/kernel/meta.json +++ b/content/docs/references/kernel/meta.json @@ -1,37 +1,42 @@ { "title": "Kernel Protocol", "pages": [ - "cli-extension", - "cluster", + "---Core Runtime---", "context", - "dependency-resolution", - "dev-plugin", "execution-context", - "feature", "manifest", - "metadata-customization", - "metadata-loader", - "metadata-persistence", - "metadata-plugin", - "metadata-protection", + "feature", + "service-registry", + "startup-orchestrator", + "cluster", + "state-machine", + "cli-extension", + "dev-plugin", "misc", - "package-artifact", - "package-registry", - "package-upgrade", + "---Plugin Lifecycle---", "plugin", - "plugin-capability", - "plugin-lifecycle-advanced", - "plugin-lifecycle-events", + "plugin-structure", "plugin-loading", - "plugin-registry", + "plugin-lifecycle-events", + "plugin-lifecycle-advanced", "plugin-runtime", + "plugin-registry", + "plugin-capability", + "---Plugin Security & Validation---", "plugin-security", "plugin-security-advanced", - "plugin-structure", "plugin-validator", "plugin-versioning", - "service-registry", - "startup-orchestrator", - "state-machine" + "---Dependencies & Packages---", + "dependency-resolution", + "package-artifact", + "package-registry", + "package-upgrade", + "---Metadata---", + "metadata-loader", + "metadata-persistence", + "metadata-plugin", + "metadata-customization", + "metadata-protection" ] -} \ No newline at end of file +} diff --git a/content/docs/references/system/meta.json b/content/docs/references/system/meta.json index c5077394c1..a6d8caf136 100644 --- a/content/docs/references/system/meta.json +++ b/content/docs/references/system/meta.json @@ -1,44 +1,51 @@ { "title": "System Protocol", "pages": [ - "app-install", - "audit", - "auth-config", - "cache", - "change-management", - "collaboration", - "compliance", + "---Runtime & Services---", "core-services", - "deploy-bundle", - "disaster-recovery", - "email-config", - "email-template", - "encryption", - "environment-artifact", "http-server", - "incident-response", + "worker", "job", - "license", - "logging", - "masking", "message-queue", + "cache", + "search-engine", + "object-storage", + "---Observability---", + "logging", + "metrics", + "tracing", + "audit", + "---Metadata & Migration---", "metadata-loader", "metadata-persistence", - "metrics", "migration", - "notification", - "object-storage", - "provisioning", - "registry-config", - "search-engine", + "change-management", + "---Security & Compliance---", + "auth-config", "security-context", - "settings-client", - "settings-manifest", + "encryption", + "masking", + "compliance", "supplier-security", + "---Tenancy & Provisioning---", "tenant", - "tracing", - "training", + "provisioning", + "app-install", + "license", + "registry-config", + "settings-manifest", + "settings-client", + "---Deployment & Operations---", + "deploy-bundle", + "environment-artifact", + "disaster-recovery", + "incident-response", + "---Communication & Localization---", + "notification", + "email-config", + "email-template", + "collaboration", "translation", - "worker" + "training" ] -} \ No newline at end of file +} diff --git a/content/docs/references/ui/meta.json b/content/docs/references/ui/meta.json index 40441070e3..b3edb5fe2c 100644 --- a/content/docs/references/ui/meta.json +++ b/content/docs/references/ui/meta.json @@ -1,27 +1,31 @@ { "title": "UI Protocol", "pages": [ - "action", - "animation", + "---Building Blocks---", "app", - "chart", + "page", + "view", "component", + "widget", + "action", + "---Data Display---", "dashboard", + "chart", + "report", "dataset", + "---Interaction---", "dnd", - "http", - "i18n", "keyboard", - "notification", - "offline", - "page", - "portal", - "report", + "touch", + "animation", "responsive", - "sharing", + "---Platform---", "theme", - "touch", - "view", - "widget" + "i18n", + "offline", + "http", + "notification", + "portal", + "sharing" ] -} \ No newline at end of file +}