Skip to content

Commit 1edc3aa

Browse files
docs(getting-started): quick-reference 计数改 (N of M schemas),并把真实参考目录纳入门 (#6530) (#7302)
按 maintainer 2026-08-08 的 Option C 裁决实施。 原来的 `(N schemas)` 是**自指**的:N 只与它自己下面那张表比对,与 content/docs/references/{category}/ 的真实面之间没有任何门在看。#6530 实测出 `## Data Protocol (17 schemas)` 之上是一个发布 29(今日 30)个 schema 页的目录, 其中 13 个页在整张页面上没有任何一行 —— 而门一直是绿的,并且永远会是绿的。 13 个标题一律改为 `(N of M schemas)`:N 仍是本表行数,M 是该分类目录实际发布的 参考页数(`.mdx` 去掉 index.mdx)。表继续保持策展子集 —— 一个把 30 个 data 页 全镜像过来的 quick reference 就不 quick 了 —— 但措辞不再读作总数,且 N < M 这个 正常状态从此有门在看。 今日 main 上全部 13 个 M 重新实测(未复用 08-08 的表):只有 data 动了,29 → 30, 因为 e2798fa(#6345 / PR #6910)在 08-09 新增了 driver-turso.mdx。这正是这道门 值得有的证据 —— 两天,一格漂移,原来的自指门看不见。 跨切规则(裁决要求随行): - 每一行都必须有链接。Shared 的 `Connector Auth` 原来是**裸名无链接**,现在指向 /docs/references/integration/connector —— 那个文件在 src/shared/,但 `@objectstack/spec/shared` 并不发布它,它经 `@objectstack/spec/integration` 到达消费者,build-docs.ts 的 `integration:` 注释与 scripts/lib/root-index.ts 都写明了这一点(后者还把 `shared/connector-auth.zod.ts` 这类行点名为缺陷类)。 Key Schemas 一并从未发布的 ConnectorAuthConfig 改为已发布的 ConnectorInstanceAuth。 - 三行指向 references/ 之外的行统一带 `↗` 标记(UI 的 Widget Contract、Kernel 的 Events、Shared 的 Connector Auth)。标记就是 N 与 M 的对账口:带标记的行算进 N, 但不是 M 里的那些页。门双向校验 —— 未标记的行必须指向本小节自己的分类目录下 一个真实存在、且不与别行重复的页;指向别处的行必须带标记;带标记却指回自己 目录的行也红,否则标记会悄悄从覆盖率里减掉一页。 - 分类级策展写在页面上而不是留作默认:新增 `## Categories Without a Section` 一节,写明 references/studio/(3 页)与 references/contracts/(0 页,只剩一个 meta.json)为何没有小节;门同样读这张表,任何分类目录必须要么有小节、要么在 这里被声明,不能两者都是、也不能两者都不是。 门的自测从 9 例扩到 22 例。第 3 例是反空转的那一例:页面内部自洽、只有目录不符, 删掉 M 断言后它实测归零(4 条断言全红),即 #6530 记录的"永远绿"状态。第 18/20 例 对分类级覆盖扫描做同样的反向验证。 Claude-Session: https://claude.ai/code/session_01F8q5J1MQyocgtNspb15fSn Co-authored-by: Claude <noreply@anthropic.com>
1 parent f758cec commit 1edc3aa

2 files changed

Lines changed: 613 additions & 134 deletions

File tree

‎content/docs/getting-started/quick-reference.mdx‎

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,18 @@ Fast lookup for the ObjectStack protocols organized by category.
1212
Click on any protocol name to view its complete API reference.
1313
</Callout>
1414

15-
## Data Protocol (17 schemas)
15+
**Reading the counts.** Every heading below says `(N of M schemas)`. **N** is how many
16+
protocols this table lists; **M** is how many reference pages the matching
17+
`content/docs/references/<category>/` directory publishes. These tables are a *curated*
18+
fast lookup, not a mirror of the reference tree — `N < M` is normal and intended. Both
19+
numbers are checked by `pnpm check:quick-reference-counts`, so a category that gains or
20+
loses a page shows up here instead of drifting unnoticed. A row marked ↗ links outside
21+
its category's reference tree: it is one of the N rows, but it is not one of the M pages.
22+
Categories that have no section here at all are named under
23+
[Categories Without a Section](#categories-without-a-section) — that curation is stated,
24+
not left implicit.
25+
26+
## Data Protocol (17 of 30 schemas)
1627

1728
Core business logic and data modeling schemas.
1829

@@ -36,7 +47,7 @@ Core business logic and data modeling schemas.
3647
| **[Postgres Driver](/docs/references/data/driver-postgres)** | `driver/postgres.zod.ts` | PostgresConfig | PostgreSQL configuration |
3748
| **[Mongo Driver](/docs/references/data/driver-mongo)** | `driver/mongo.zod.ts` | MongoConfig | MongoDB configuration |
3849

39-
## UI Protocol (11 schemas)
50+
## UI Protocol (11 of 16 schemas)
4051

4152
Presentation layer - views, forms, dashboards, and themes.
4253

@@ -52,9 +63,9 @@ Presentation layer - views, forms, dashboards, and themes.
5263
| **[Component](/docs/references/ui/component)** | `component.zod.ts` | PageComponent variants | Reusable UI components |
5364
| **[Chart](/docs/references/ui/chart)** | `chart.zod.ts` | Chart, ChartType | Chart definitions |
5465
| **[Theme](/docs/references/ui/theme)** | `theme.zod.ts` | Theme, ColorPalette | Theming and branding |
55-
| **[Widget Contract](/docs/protocol/objectui/widget-contract)** | `widget.zod.ts` | FieldWidgetProps | Props a custom field widget receives |
66+
| **[Widget Contract](/docs/protocol/objectui/widget-contract)** ↗ | `widget.zod.ts` | FieldWidgetProps | Props a custom field widget receives — the contract is documented with ObjectUI, outside `references/ui/` |
5667

57-
## Kernel Protocol (17 schemas)
68+
## Kernel Protocol (17 of 31 schemas)
5869

5970
Plugin architecture, manifests, and kernel runtime.
6071

@@ -74,11 +85,11 @@ Plugin architecture, manifests, and kernel runtime.
7485
| **[Plugin Versioning](/docs/references/kernel/plugin-versioning)** | `plugin-versioning.zod.ts` | PluginCompatibilityMatrix, DeprecationNotice | Version compatibility |
7586
| **[Service Registry](/docs/references/kernel/service-registry)** | `service-registry.zod.ts` | ServiceRegistryConfig, ServiceMetadata | Service discovery |
7687
| **[Startup Orchestrator](/docs/references/kernel/startup-orchestrator)** | `startup-orchestrator.zod.ts` | StartupOptions, StartupOrchestrationResult | System startup |
77-
| **[Events](/docs/kernel/events)** | `events.zod.ts` | Event, EventBusConfig | System event bus |
88+
| **[Events](/docs/kernel/events)** ↗ | `events.zod.ts` | Event, EventBusConfig | System event bus — the hand-written guide, outside `references/kernel/` (which splits the same surface across six `events-*` pages) |
7889
| **[Metadata Loader](/docs/references/kernel/metadata-loader)** | `metadata-loader.zod.ts` | MetadataLoaderContract | Metadata loading |
7990
| **[Package Registry](/docs/references/kernel/package-registry)** | `package-registry.zod.ts` | InstalledPackage, InstallPackageRequest | Package resolution |
8091

81-
## System Protocol (18 schemas)
92+
## System Protocol (18 of 37 schemas)
8293

8394
Runtime environment, logging, jobs, caching, and observability.
8495

@@ -103,7 +114,7 @@ Runtime environment, logging, jobs, caching, and observability.
103114
| **[Translation](/docs/references/system/translation)** | `translation.zod.ts` | Translation | i18n support |
104115
| **[Worker](/docs/references/system/worker)** | `worker.zod.ts` | Worker | Background workers |
105116

106-
## AI Protocol (11 schemas)
117+
## AI Protocol (11 of 11 schemas)
107118

108119
AI/ML capabilities - agents, skills, tools, MCP exposure, RAG, and cost tracking.
109120

@@ -121,7 +132,7 @@ AI/ML capabilities - agents, skills, tools, MCP exposure, RAG, and cost tracking
121132
| **[Usage](/docs/references/ai/usage)** | `usage.zod.ts` | AIUsageRecord, TokenUsage | AI usage and cost tracking |
122133
| **[Solution Blueprint](/docs/references/ai/solution-blueprint)** | `solution-blueprint.zod.ts` | BlueprintObject, BlueprintApp | Blueprint format for AI app generation |
123134

124-
## API Protocol (17 schemas)
135+
## API Protocol (17 of 28 schemas)
125136

126137
REST/GraphQL endpoints, real-time subscriptions, and discovery.
127138

@@ -145,7 +156,7 @@ REST/GraphQL endpoints, real-time subscriptions, and discovery.
145156
| **[Metadata](/docs/references/api/metadata)** | `metadata.zod.ts` | Metadata | API metadata endpoints |
146157
| **[Storage](/docs/references/api/storage)** | `storage.zod.ts` | Storage | API storage operations |
147158

148-
## Automation Protocol (4 schemas)
159+
## Automation Protocol (4 of 13 schemas)
149160

150161
Flows, state machines, approvals, and integrations.
151162

@@ -156,7 +167,7 @@ Flows, state machines, approvals, and integrations.
156167
| **[State Machine](/docs/references/automation/state-machine)** | `state-machine.zod.ts` | StateMachine | State machine definitions |
157168
| **[Webhook](/docs/references/automation/webhook)** | `webhook.zod.ts` | Webhook | Outbound webhooks |
158169

159-
## Security Protocol (3 schemas)
170+
## Security Protocol (3 of 5 schemas)
160171

161172
Access control, permissions, and row-level security.
162173

@@ -166,7 +177,7 @@ Access control, permissions, and row-level security.
166177
| **[RLS](/docs/references/security/rls)** | `rls.zod.ts` | RowLevelSecurityPolicy | Row-level security filters |
167178
| **[Sharing](/docs/references/security/sharing)** | `sharing.zod.ts` | SharingRule | Record sharing rules |
168179

169-
## Identity Protocol (4 schemas)
180+
## Identity Protocol (4 of 5 schemas)
170181

171182
User identity, organizations, and position management.
172183

@@ -177,7 +188,7 @@ User identity, organizations, and position management.
177188
| **[Position](/docs/references/identity/position)** | `position.zod.ts` | Position | Permission-set distribution (岗位, ADR-0090) |
178189
| **[SCIM](/docs/references/identity/scim)** | `scim.zod.ts` | SCIMUser, SCIMGroup | SCIM 2.0 provisioning |
179190

180-
## Cloud Protocol (3 schemas)
191+
## Cloud Protocol (3 of 11 schemas)
181192

182193
Environments, marketplace, licensing, and multi-tenancy.
183194

@@ -187,7 +198,7 @@ Environments, marketplace, licensing, and multi-tenancy.
187198
| **[Marketplace](/docs/references/cloud/marketplace)** | `marketplace.zod.ts` | MarketplaceListing, PackageSubmission | Plugin marketplace |
188199
| **[Tenant](/docs/references/cloud/tenant)** | `tenant.zod.ts` | Tenant | Multi-tenancy isolation |
189200

190-
## Integration Protocol (1 schema)
201+
## Integration Protocol (1 of 1 schema)
191202

192203
External system connectors — one protocol (ADR-0097): a connector entry is
193204
either a catalog descriptor or a provider-bound instance that a generic
@@ -200,7 +211,7 @@ from the provider itself, not from hand-written spec files.
200211
|:---------|:-----------|:------------|:--------|
201212
| **[Connector](/docs/references/integration/connector)** | `connector.zod.ts` | Connector | The connector protocol — auth, sync, webhooks, rate limiting |
202213

203-
## Shared Protocol (5 schemas)
214+
## Shared Protocol (5 of 8 schemas)
204215

205216
Common utilities used across all protocols.
206217

@@ -210,16 +221,28 @@ Common utilities used across all protocols.
210221
| **[HTTP](/docs/references/shared/http)** | `http.zod.ts` | HttpRequest, HttpMethod, CorsConfig | HTTP utilities |
211222
| **[Identifiers](/docs/references/shared/identifiers)** | `identifiers.zod.ts` | SystemIdentifier, SnakeCaseIdentifier | Standard ID patterns |
212223
| **[Mapping](/docs/references/shared/mapping)** | `mapping.zod.ts` | FieldMapping | Field mapping utilities |
213-
| **Connector Auth** | `connector-auth.zod.ts` | ConnectorAuthConfig | Connector auth patterns |
224+
| **[Connector Auth](/docs/references/integration/connector)** ↗ | `connector-auth.zod.ts` | ConnectorInstanceAuth | Declarative connector auth (ADR-0097). The file sits in `src/shared/` but `@objectstack/spec/shared` does not publish it — it reaches consumers through `@objectstack/spec/integration`, so it is documented on the Connector page |
214225

215-
## QA Protocol (1 schema)
226+
## QA Protocol (1 of 1 schema)
216227

217228
Testing and quality assurance.
218229

219230
| Protocol | Source File | Key Schemas | Purpose |
220231
|:---------|:-----------|:------------|:--------|
221232
| **[Testing](/docs/references/qa/testing)** | `testing.zod.ts` | TestSuite | Declarative test definitions |
222233

234+
## Categories Without a Section
235+
236+
`content/docs/references/` holds two more category directories that deliberately get no
237+
section above. Curation happens at the category level as well as inside each table, and
238+
this is where it is stated. The same gate reads this table, so a new category directory —
239+
or a page landing in one of these — goes red until this page is updated.
240+
241+
| Category directory | Pages | Why it has no section |
242+
|:---|---:|:---|
243+
| [`studio`](/docs/references/studio) | 3 | Designer-facing metadata (`flow-builder`, `object-designer`, `plugin`) — Studio's own authoring surfaces, not protocols an app declares. Reach them from the [reference index](/docs/references). |
244+
| `contracts` | 0 | Publishes no reference page at all; the directory holds only a `meta.json` left over from an earlier layout. There is nothing to link. |
245+
223246
---
224247

225248
## Common Patterns

0 commit comments

Comments
 (0)