Skip to content

Commit 201ab12

Browse files
committed
chore(docs): 合入 main 后整体重跑 gen:schema && gen:docs (#5553, #6136)
纯生成物,由 `pnpm --filter @objectstack/spec build && … gen:docs` 在合并后的 源码树上整体产出(#4675 第四步),而非把两侧各自的生成物文本拼接。 与 #6211(#5340 内联长枚举省略)同树共存已核实: - 省略标记 `… +N more` 全语料 160 处,与 origin/main 完全一致(160)。 - 两者受影响页面交集 33 张,逐页复核 description 区(本 PR)与 type 单元格 (#6211)各自的效果同时在位。例如 integration/connector.mdx 第 68 行「另见」 为单个可点链接(#6136),同页 3 处 `… +N more`(#6211);security/explain.mdx 开篇跨行行内代码跨度完整(#5553),同页 4 处省略标记。 - 验收复跑:`[../[` 归零;按段落计未配对反引号归零;代码跨度内 `\{` 残留归零。 - 全量 216 张参考页经 @mdx-js/mdx 编译通过。 - 无页面新增或丢失开篇描述。
1 parent c500a43 commit 201ab12

169 files changed

Lines changed: 547 additions & 2450 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/docs/references/ai/conversation.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ description: Conversation protocol schemas
88
AI Conversation Memory Protocol
99

1010
Multi-turn AI conversations with token budget management.
11-
1211
Enables context preservation, conversation history, and token optimization.
1312

1413
<Callout type="info">

content/docs/references/ai/embedding.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,17 @@ Embedding & Vector Store Primitives
1010
Platform contract for configuring embedding models and vector stores.
1111

1212
Scope (intentionally minimal):
13-
1413
- How to reference an embedding model (provider + model name + secret).
15-
1614
- How to reference a vector store (provider + connection).
1715

1816
NOT in scope (these belong to application code, not the platform):
19-
2017
- Chunking strategies (fixed/semantic/recursive/markdown).
21-
2218
- Retrieval pipelines (rerankers, multi-stage retrieval, filters).
23-
2419
- Document loaders / ingestion DSLs.
25-
2620
- End-to-end RAG pipeline orchestration.
2721

2822
These were removed in v1 because they describe one specific way to
29-
3023
build a RAG application; the platform's job is to expose the embed +
31-
3224
vector primitives so any RAG strategy can be built on top.
3325

3426
<Callout type="info">

content/docs/references/ai/knowledge-document.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,11 @@ description: Knowledge Document protocol schemas
66
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
77

88
Knowledge Document / Chunk / Hit — canonical shapes shared by every
9-
109
`IKnowledgeAdapter` implementation.
1110

1211
The framework does **not** prescribe chunk strategy or vector
13-
1412
format. Adapters are free to chunk however they like; the framework
15-
1613
only requires they round-trip these shapes when talking to the
17-
1814
`IKnowledgeService`.
1915

2016
See `content/docs/protocol/knowledge.mdx` for the full design.

content/docs/references/ai/knowledge-source.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,12 @@ description: Knowledge Source protocol schemas
66
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
77

88
Knowledge Source — declarative metadata describing what to index and
9-
109
which adapter to use.
1110

1211
A KnowledgeSource is the metadata-level equivalent of an
13-
1412
`IDataEngine` driver binding: it pairs a logical source description
15-
1613
(object/file/http) with the *id* of an `IKnowledgeAdapter` plugin
17-
1814
that will actually do the work. The adapter resolves the id at
19-
2015
runtime via `IKnowledgeService.registerAdapter`.
2116

2217
See `content/docs/protocol/knowledge.mdx` for the full design.

content/docs/references/ai/mcp.mdx

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,20 @@ description: Mcp protocol schemas
88
Model Context Protocol (MCP) — Reference & Binding Primitives
99

1010
MCP itself is an external protocol defined by Anthropic
11-
1211
(https://modelcontextprotocol.io). The platform does NOT re-define
13-
1412
MCP's wire format, transport, or message shapes — that is the job
15-
1613
of the `@modelcontextprotocol/sdk` consumed by `@objectstack/mcp`.
1714

1815
This file defines only the two things the *platform* needs:
1916

2017
1. **MCPServerRef** — how a project references an external MCP
21-
22-
server (so an agent can mount its tools).
23-
18+
server (so an agent can mount its tools).
2419
2. **MCPToolBinding** — how an MCP tool from a referenced server
25-
26-
is exposed as an ObjectStack `AIToolDefinition` (alias,
27-
28-
visibility, approval policy).
20+
is exposed as an ObjectStack `AIToolDefinition` (alias,
21+
visibility, approval policy).
2922

3023
Everything else (transport details, capability negotiation,
31-
3224
resource/prompt shapes, streaming, sampling) is handled by the SDK
33-
3425
at runtime and does not need a metadata representation.
3526

3627
<Callout type="info">

content/docs/references/ai/model-registry.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ description: Model Registry protocol schemas
88
AI Model Registry Protocol
99

1010
Centralized registry for managing AI models, prompt templates, and model versioning.
11-
1211
Enables AI-powered ObjectStack applications to discover and use LLMs consistently.
1312

1413
<Callout type="info">

content/docs/references/ai/skill.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ description: Skill protocol schemas
88
Skill Trigger Condition Schema
99

1010
Defines programmatic conditions under which a skill becomes active.
11-
1211
Allows context-aware activation based on object type, user role, etc.
1312

1413
<Callout type="info">

content/docs/references/ai/usage.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,17 @@ AI Usage Primitives
1010
Platform contract for measuring AI consumption.
1111

1212
Scope (intentionally minimal):
13-
1413
- Token usage per call.
15-
1614
- Per-call cost (computed from a model's unit price).
17-
1815
- Model unit pricing.
1916

2017
NOT in scope (deferred to FinOps / product layer):
21-
2218
- Budget definitions, enforcement, alerts.
23-
2419
- Cost allocation / chargeback / reports.
25-
2620
- Optimization recommendations.
2721

2822
Rationale: the platform must record *what was used*; deciding what
29-
3023
to do about it (block calls, send alerts, allocate to cost centers)
31-
3224
is product policy that varies wildly between tenants.
3325

3426
<Callout type="info">

content/docs/references/api/analytics.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ description: Analytics protocol schemas
88
Analytics API Protocol
99

1010
Defines the HTTP interface for the Semantic Layer.
11-
1211
Provides endpoints for executing analytical queries and discovering metadata.
1312

1413
<Callout type="info">

content/docs/references/api/auth-endpoints.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,10 @@ description: Auth Endpoints protocol schemas
88
Authentication Endpoint Specification
99

1010
Defines the canonical HTTP endpoints for the authentication service.
11-
1211
Based on better-auth v1.4.18 endpoint conventions.
1312

1413
NOTE: ObjectStack's auth implementation uses better-auth library which has
15-
1614
established endpoint conventions. This spec documents those conventions as
17-
1815
the canonical API contract.
1916

2017
<Callout type="info">

0 commit comments

Comments
 (0)