Skip to content

Commit f0e9267

Browse files
os-zhuangclaude
andcommitted
docs(nav): group Protocol Reference modules and clarify top-level nav
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) <noreply@anthropic.com>
1 parent bca06f3 commit f0e9267

10 files changed

Lines changed: 169 additions & 135 deletions

File tree

content/docs/protocol/meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"title": "Protocol",
2+
"title": "Protocol Overview",
33
"pages": ["index", "objectql", "objectui", "objectos", "knowledge"]
44
}
Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
{
22
"title": "AI Protocol",
33
"pages": [
4+
"---Agents & Tools---",
45
"agent",
6+
"tool",
7+
"skill",
58
"conversation",
6-
"embedding",
7-
"knowledge-document",
8-
"knowledge-source",
99
"mcp",
10+
"---Knowledge & Embeddings---",
11+
"knowledge-source",
12+
"knowledge-document",
13+
"embedding",
14+
"---Models & Solutions---",
1015
"model-registry",
11-
"skill",
1216
"solution-blueprint",
13-
"tool",
1417
"usage"
1518
]
16-
}
19+
}
Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,50 @@
11
{
22
"title": "API Protocol",
33
"pages": [
4-
"analytics",
5-
"auth",
6-
"auth-endpoints",
7-
"automation-api",
8-
"batch",
9-
"connector",
10-
"contract",
4+
"---Overview---",
5+
"protocol",
116
"core-services",
12-
"discovery",
13-
"dispatcher",
147
"documentation",
8+
"discovery",
9+
"---REST & HTTP---",
10+
"rest-server",
11+
"router",
1512
"endpoint",
16-
"errors",
17-
"events",
13+
"object",
14+
"batch",
1815
"export",
19-
"feed-api",
20-
"graphql",
2116
"http",
2217
"http-cache",
23-
"identity",
18+
"errors",
19+
"versioning",
20+
"---Query Interfaces---",
21+
"query-adapter",
22+
"graphql",
23+
"odata",
24+
"analytics",
2425
"metadata",
2526
"metadata-plugin",
27+
"contract",
28+
"---Auth & Identity---",
29+
"auth",
30+
"auth-endpoints",
31+
"identity",
32+
"---Realtime & Events---",
33+
"realtime",
34+
"realtime-shared",
35+
"websocket",
36+
"events",
37+
"dispatcher",
2638
"notification",
27-
"object",
28-
"odata",
39+
"feed-api",
40+
"---Automation & Integration---",
41+
"automation-api",
42+
"connector",
43+
"plugin-rest-api",
44+
"---Packages & Storage---",
2945
"package-api",
3046
"package-registry",
31-
"plugin-rest-api",
32-
"protocol",
33-
"query-adapter",
34-
"realtime",
35-
"realtime-shared",
3647
"registry",
37-
"rest-server",
38-
"router",
39-
"storage",
40-
"versioning",
41-
"websocket"
48+
"storage"
4249
]
43-
}
50+
}
Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
{
22
"title": "Automation Protocol",
33
"pages": [
4-
"approval",
5-
"bpmn-interop",
6-
"connector",
7-
"etl",
8-
"execution",
4+
"---Flows & Execution---",
95
"flow",
10-
"job",
6+
"execution",
117
"node-executor",
12-
"offline",
138
"state-machine",
14-
"sync",
9+
"bpmn-interop",
10+
"---Triggers & Jobs---",
1511
"trigger-registry",
16-
"webhook"
12+
"job",
13+
"webhook",
14+
"offline",
15+
"---Workflows & Integration---",
16+
"approval",
17+
"etl",
18+
"sync",
19+
"connector"
1720
]
18-
}
21+
}
Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
{
22
"title": "Cloud Protocol",
33
"pages": [
4-
"app-store",
5-
"developer-portal",
4+
"---Environments---",
65
"environment",
76
"environment-artifact",
87
"environment-package",
8+
"provisioning",
9+
"tenant",
10+
"---Marketplace & Distribution---",
911
"marketplace",
1012
"marketplace-admin",
13+
"app-store",
14+
"developer-portal",
15+
"---Packages---",
1116
"package",
1217
"package-version",
13-
"plugin-security",
14-
"provisioning",
1518
"template-manifest",
16-
"tenant"
19+
"plugin-security"
1720
]
18-
}
21+
}

content/docs/references/contracts/meta.json

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,35 @@
11
{
22
"title": "Data Protocol",
33
"pages": [
4+
"---Core Modeling---",
5+
"object",
6+
"field",
7+
"validation",
8+
"mapping",
9+
"document",
10+
"---Query & Filter---",
11+
"query",
12+
"filter",
13+
"date-macros",
414
"analytics",
15+
"---Engine & Drivers---",
516
"data-engine",
617
"datasource",
7-
"date-macros",
8-
"document",
918
"driver",
10-
"driver-nosql",
1119
"driver-sql",
12-
"external-catalog",
13-
"external-lookup",
14-
"feed",
15-
"field",
16-
"filter",
20+
"driver-nosql",
21+
"---Hooks & Lifecycle---",
1722
"hook",
1823
"hook-body",
19-
"mapping",
24+
"subscription",
25+
"feed",
2026
"notification",
21-
"object",
22-
"query",
27+
"---External Data---",
28+
"external-catalog",
29+
"external-lookup",
2330
"search-engine",
31+
"---Seeding---",
2432
"seed",
25-
"seed-loader",
26-
"subscription",
27-
"validation"
33+
"seed-loader"
2834
]
29-
}
35+
}
Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,42 @@
11
{
22
"title": "Kernel Protocol",
33
"pages": [
4-
"cli-extension",
5-
"cluster",
4+
"---Core Runtime---",
65
"context",
7-
"dependency-resolution",
8-
"dev-plugin",
96
"execution-context",
10-
"feature",
117
"manifest",
12-
"metadata-customization",
13-
"metadata-loader",
14-
"metadata-persistence",
15-
"metadata-plugin",
16-
"metadata-protection",
8+
"feature",
9+
"service-registry",
10+
"startup-orchestrator",
11+
"cluster",
12+
"state-machine",
13+
"cli-extension",
14+
"dev-plugin",
1715
"misc",
18-
"package-artifact",
19-
"package-registry",
20-
"package-upgrade",
16+
"---Plugin Lifecycle---",
2117
"plugin",
22-
"plugin-capability",
23-
"plugin-lifecycle-advanced",
24-
"plugin-lifecycle-events",
18+
"plugin-structure",
2519
"plugin-loading",
26-
"plugin-registry",
20+
"plugin-lifecycle-events",
21+
"plugin-lifecycle-advanced",
2722
"plugin-runtime",
23+
"plugin-registry",
24+
"plugin-capability",
25+
"---Plugin Security & Validation---",
2826
"plugin-security",
2927
"plugin-security-advanced",
30-
"plugin-structure",
3128
"plugin-validator",
3229
"plugin-versioning",
33-
"service-registry",
34-
"startup-orchestrator",
35-
"state-machine"
30+
"---Dependencies & Packages---",
31+
"dependency-resolution",
32+
"package-artifact",
33+
"package-registry",
34+
"package-upgrade",
35+
"---Metadata---",
36+
"metadata-loader",
37+
"metadata-persistence",
38+
"metadata-plugin",
39+
"metadata-customization",
40+
"metadata-protection"
3641
]
37-
}
42+
}
Lines changed: 36 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,51 @@
11
{
22
"title": "System Protocol",
33
"pages": [
4-
"app-install",
5-
"audit",
6-
"auth-config",
7-
"cache",
8-
"change-management",
9-
"collaboration",
10-
"compliance",
4+
"---Runtime & Services---",
115
"core-services",
12-
"deploy-bundle",
13-
"disaster-recovery",
14-
"email-config",
15-
"email-template",
16-
"encryption",
17-
"environment-artifact",
186
"http-server",
19-
"incident-response",
7+
"worker",
208
"job",
21-
"license",
22-
"logging",
23-
"masking",
249
"message-queue",
10+
"cache",
11+
"search-engine",
12+
"object-storage",
13+
"---Observability---",
14+
"logging",
15+
"metrics",
16+
"tracing",
17+
"audit",
18+
"---Metadata & Migration---",
2519
"metadata-loader",
2620
"metadata-persistence",
27-
"metrics",
2821
"migration",
29-
"notification",
30-
"object-storage",
31-
"provisioning",
32-
"registry-config",
33-
"search-engine",
22+
"change-management",
23+
"---Security & Compliance---",
24+
"auth-config",
3425
"security-context",
35-
"settings-client",
36-
"settings-manifest",
26+
"encryption",
27+
"masking",
28+
"compliance",
3729
"supplier-security",
30+
"---Tenancy & Provisioning---",
3831
"tenant",
39-
"tracing",
40-
"training",
32+
"provisioning",
33+
"app-install",
34+
"license",
35+
"registry-config",
36+
"settings-manifest",
37+
"settings-client",
38+
"---Deployment & Operations---",
39+
"deploy-bundle",
40+
"environment-artifact",
41+
"disaster-recovery",
42+
"incident-response",
43+
"---Communication & Localization---",
44+
"notification",
45+
"email-config",
46+
"email-template",
47+
"collaboration",
4148
"translation",
42-
"worker"
49+
"training"
4350
]
44-
}
51+
}

0 commit comments

Comments
 (0)