Skip to content

Commit 28a0857

Browse files
os-zhuangclaude
andauthored
docs: migrate protocol/objectos → protocol/kernel (URL-level layer-name retirement) (#2960)
* docs: migrate protocol/objectos → protocol/kernel (URL-level layer-name retirement) Completes the ObjectOS layer-name retirement (#2955) at the URL level: - content/docs/protocol/objectos/ → content/docs/protocol/kernel/ (11 pages, git mv — history preserved) - permanent redirect /docs/protocol/objectos/:path* → /docs/protocol/kernel/:path* added to the redirects table (folder-moves section) - all in-content links rewritten (protocol index/cards, objectui index, automation, api, kernel, concepts/architecture, plugins, package READMEs); historical audit docs left as-is — the redirect covers them - protocol/meta.json: objectos → kernel Verified: turbo build --filter=@objectstack/docs green (4m08s); zero remaining protocol/objectos references outside the redirects table. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0162o68e5w3bpUBEVRQboUGG * chore: rebase role-word baseline for protocol/objectos → protocol/kernel move The guard keys its baseline by path; git mv made the 3 baselined occurrences show up as 'new' under kernel/ and 'gone' under objectos/. Occurrence counts are unchanged (6 total). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0162o68e5w3bpUBEVRQboUGG --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 8b27dd7 commit 28a0857

32 files changed

Lines changed: 189 additions & 65 deletions

apps/docs/redirects.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,9 @@ export const docsRedirects = [
109109
// folder moves (wildcards — keep after exact entries)
110110
['/docs/guides/runtime-services/:path*', '/docs/kernel/runtime-services/:path*'],
111111
['/docs/guides/contracts/:path*', '/docs/kernel/contracts/:path*'],
112+
// ObjectOS layer-name retirement: the System Protocol section is now "kernel"
113+
// (:path* matches zero or more segments, so this also covers the bare URL)
114+
['/docs/protocol/objectos/:path*', '/docs/protocol/kernel/:path*'],
112115
// safety net for anything else under retired sections — keep last
113116
['/docs/guides/:path*', '/docs'],
114117
];

content/docs/api/data-flow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ flowchart LR
212212
How data changes propagate to connected clients in real time.
213213

214214
<Callout type="warn">
215-
**Implementation status:** This diagram (and the `emit(...)``EB->>WS` broadcast step in the Write Flow diagram above) shows the target design. The realtime service that ships today is an **in-memory pub/sub adapter** (`InMemoryRealtimeAdapter` in `@objectstack/service-realtime`), delivered to JS clients via **long-polling** (`RealtimeAPI` in `@objectstack/client`) — no WebSocket transport is wired up yet. The adapter also only matches subscriptions by `object` and `eventTypes`; per-field `filter` conditions (e.g. `{ project: 'prj_1' }`) are accepted in the request shape but are not yet enforced server-side. See [Real-Time Protocols](/docs/protocol/objectos/realtime-protocol) for the full implementation-status breakdown.
215+
**Implementation status:** This diagram (and the `emit(...)``EB->>WS` broadcast step in the Write Flow diagram above) shows the target design. The realtime service that ships today is an **in-memory pub/sub adapter** (`InMemoryRealtimeAdapter` in `@objectstack/service-realtime`), delivered to JS clients via **long-polling** (`RealtimeAPI` in `@objectstack/client`) — no WebSocket transport is wired up yet. The adapter also only matches subscriptions by `object` and `eventTypes`; per-field `filter` conditions (e.g. `{ project: 'prj_1' }`) are accepted in the request shape but are not yet enforced server-side. See [Real-Time Protocols](/docs/protocol/kernel/realtime-protocol) for the full implementation-status breakdown.
216216
</Callout>
217217

218218
```mermaid

content/docs/api/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ See [Actions as Tools](/docs/ai/actions-as-tools) for the `run_action` bridge an
7171
- [Error Catalog](/docs/api/error-catalog) — the full list of error codes
7272
- [Wire Format](/docs/api/wire-format) — request/response envelopes on the wire
7373

74-
Spec: [HTTP API](/docs/protocol/objectos/http-protocol), [Real-Time Protocols](/docs/protocol/objectos/realtime-protocol)
74+
Spec: [HTTP API](/docs/protocol/kernel/http-protocol), [Real-Time Protocols](/docs/protocol/kernel/realtime-protocol)
7575

7676
Schema reference: [API](/docs/references/api)
7777

content/docs/automation/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,6 @@ Rule of thumb: model *state* with workflows, model *steps* with flows, use hooks
4949

5050
## Related
5151

52-
- **Spec:** [State Machine (Lifecycle)](/docs/protocol/objectql/state-machine), [Runtime Capabilities](/docs/protocol/objectos/runtime-capabilities)
52+
- **Spec:** [State Machine (Lifecycle)](/docs/protocol/objectql/state-machine), [Runtime Capabilities](/docs/protocol/kernel/runtime-capabilities)
5353
- **Schema reference:** [Automation](/docs/references/automation)
5454
- **Neighbors:** validation rules that block bad data live in [Data Modeling](/docs/data-modeling/validation); who may trigger an automation is governed by [Permissions & Identity](/docs/permissions); the services hooks call (email, queue, storage…) are documented in [Kernel & Services](/docs/kernel/runtime-services).

content/docs/concepts/architecture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,7 @@ The three protocols are **loosely coupled** but **tightly integrated**:
561561

562562
- [ObjectQL: Data Protocol](/docs/protocol/objectql) - Full data protocol specification
563563
- [ObjectUI: UI Protocol](/docs/protocol/objectui) - Full view protocol specification
564-
- [Kernel: System Protocol](/docs/protocol/objectos) - Full control protocol specification
564+
- [Kernel: System Protocol](/docs/protocol/kernel) - Full control protocol specification
565565
- [Developer Guide](/docs/getting-started/quick-start) - Build your first ObjectStack application
566566

567567
---

content/docs/kernel/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: The ObjectKernel runtime — plugin host, event bus, service regist
55

66
# Kernel & Services
77

8-
The kernel is ObjectStack's runtime: it loads your metadata artifact, hosts plugins, wires up services, and enforces the lifecycle that keeps the system stable. This module documents the **ObjectOS layer** in practice — the [System Protocol](/docs/protocol/objectos) is its normative spec. If you write hooks or plugins, this is where the capability surface you call — `ctx.api`, `ctx.getService(...)`, and the `services.*` contract they implement — is documented.
8+
The kernel is ObjectStack's runtime: it loads your metadata artifact, hosts plugins, wires up services, and enforces the lifecycle that keeps the system stable. This module documents the **ObjectOS layer** in practice — the [System Protocol](/docs/protocol/kernel) is its normative spec. If you write hooks or plugins, this is where the capability surface you call — `ctx.api`, `ctx.getService(...)`, and the `services.*` contract they implement — is documented.
99

1010
## How it fits together
1111

@@ -40,6 +40,6 @@ The kernel is ObjectStack's runtime: it loads your metadata artifact, hosts plug
4040

4141
## Related
4242

43-
- **Spec:** [System Lifecycle](/docs/protocol/objectos/lifecycle), [Runtime Capabilities](/docs/protocol/objectos/runtime-capabilities), [Metadata Service](/docs/protocol/objectos/metadata-service)
43+
- **Spec:** [System Lifecycle](/docs/protocol/kernel/lifecycle), [Runtime Capabilities](/docs/protocol/kernel/runtime-capabilities), [Metadata Service](/docs/protocol/kernel/metadata-service)
4444
- **Schema reference:** [Kernel](/docs/references/kernel), [System](/docs/references/system), [Contracts](/docs/references/contracts)
4545
- **Neighbors:** building and packaging plugins is covered in [Plugins & Packages](/docs/plugins); running the kernel in production is covered in [Deployment & Operations](/docs/deployment).

content/docs/plugins/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ObjectStack is built on a **microkernel architecture** where nearly everything b
1818
- **[Package Overview](/docs/plugins/packages)** — All ObjectStack packages, services, drivers, plugins, and adapters
1919
- **[Adding a Metadata Type](/docs/plugins/adding-a-metadata-type)** — Register a new metadata type in the Studio Metadata Admin
2020
- Schema reference: [Kernel](/docs/references/kernel)
21-
- Spec: [Plugin Package Specification](/docs/protocol/objectos/plugin-spec)
21+
- Spec: [Plugin Package Specification](/docs/protocol/kernel/plugin-spec)
2222

2323
---
2424

content/docs/protocol/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The ObjectStack Protocol defines three interconnected layers that together descr
1212
<Cards>
1313
<Card icon={<Database />} title="ObjectQL: Data Protocol" href="/docs/protocol/objectql" description="Schema definitions, field types, state machines, query syntax, and data security." />
1414
<Card icon={<Layout />} title="ObjectUI: UI Protocol" href="/docs/protocol/objectui" description="Server-driven UI contracts for layouts, widgets, forms, and actions." />
15-
<Card icon={<Cpu />} title="Kernel: System Protocol" href="/docs/protocol/objectos" description="Runtime lifecycle, HTTP/realtime protocols, plugins, configuration, and i18n." />
15+
<Card icon={<Cpu />} title="Kernel: System Protocol" href="/docs/protocol/kernel" description="Runtime lifecycle, HTTP/realtime protocols, plugins, configuration, and i18n." />
1616
</Cards>
1717

1818
## Design Principles

content/docs/protocol/objectos/config-resolution.mdx renamed to content/docs/protocol/kernel/config-resolution.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -898,4 +898,4 @@ ObjectStack configuration resolution:
898898
- **Boot-time validation** using Zod schemas
899899
- **Inspection tools** for debugging config issues
900900

901-
**Next:** Learn about internationalization in [i18n Standard](/docs/protocol/objectos/i18n-standard).
901+
**Next:** Learn about internationalization in [i18n Standard](/docs/protocol/kernel/i18n-standard).

content/docs/protocol/objectos/error-handling.mdx renamed to content/docs/protocol/kernel/error-handling.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1047,12 +1047,12 @@ for (let i = 0; i < 1000000; i++) {
10471047
icon={<Radio />}
10481048
title="HTTP API"
10491049
description="Learn REST endpoint conventions and CRUD operations"
1050-
href="/docs/protocol/objectos/http-protocol"
1050+
href="/docs/protocol/kernel/http-protocol"
10511051
/>
10521052
<Card
10531053
icon={<Zap />}
10541054
title="Real-Time Protocols"
10551055
description="Implement WebSocket subscriptions and event streaming"
1056-
href="/docs/protocol/objectos/realtime-protocol"
1056+
href="/docs/protocol/kernel/realtime-protocol"
10571057
/>
10581058
</Cards>

0 commit comments

Comments
 (0)