Skip to content

docs: reframe AI + SSO for the open-source site; remove cloud-only intro pages#2649

Merged
os-zhuang merged 1 commit into
mainfrom
claude/docs-review-cleanup-6zv1ee
Jul 5, 2026
Merged

docs: reframe AI + SSO for the open-source site; remove cloud-only intro pages#2649
os-zhuang merged 1 commit into
mainfrom
claude/docs-review-cleanup-6zv1ee

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

背景

当前是开源(社区版)文档站点。本 PR 按两条原则清理 cloud/Enterprise 相关内容:①删除真正 cloud-only 的介绍文档;②纠正"宣称企业版专属、实为社区版已有"的说法。每条判断都对照本仓库 packages/ 的实际代码(或其不存在)验证。

1. 删除纯 cloud 介绍文档

packages/ 中核实这些能力确不在开源版:

  • ai/chatbot-integration.mdx —— in-product chat / HITL,依赖 @objectstack/service-ai(cloud,ADR-0025)。
  • deployment/cloud-artifact-api.mdx —— Cloud 控制面 artifact HTTP 契约。

同步更新导航(meta.json)与两处入站交叉链接(ai/indexdeployment/publish-and-preview),无死链残留。

2. 外科式重构:开源能力不再被框成企业版专属

开源框架除 in-product 聊天运行时外已具备整套 AI 能力:

  • AI:agents/tools/skills 是类型化元数据(defineAgent/defineTool/defineSkill,@objectstack/spec/ai);数据查询与 action 调用经 @objectstack/mcp(BYO-AI,受 RLS 约束);知识/RAG 栈(service-knowledge + knowledge-memory/knowledge-ragflow + embedder-openai)全开源。 in-product 的 ask/build 聊天运行时(@objectstack/service-ai/api/v1/ai/*)属 cloud/Enterprise —— 现已明确标注,不再充当默认叙事。涉及 ai/indexagentsactions-as-toolsknowledge-ragnatural-language-queries。同时纠正 actions 的 "explicit opt-in" 措辞:开源 MCP 路径按权限过滤,而非 cloud-only 的 ai.exposed 开关。
  • 认证:OIDC + SAML SSO 已在开源 @objectstack/plugin-auth(经 @better-auth/sso,Setup → SSO Providers,无需代码);sso.mdx 不再暗示需要企业版包。

验证

每条开源/cloud 判断都以 packages/ 佐证(或以其缺失佐证):@objectstack/mcpservice-knowledgeknowledge-*embedder-openaiplugin-auth 的 SSO/SCIM 均存在;@objectstack/service-ai 不存在。重构示例中还修正了一个虚构的 MCP 装配 API(MCPServerPlugin.configure(...) → 真实的 new MCPServerPlugin({ transport, autoStart }))。所有改动文件已通过 frontmatter / 代码围栏 / JSX 组件配平校验,内部链接全部有效。

给维护者的提示(源头不一致)

packages/spec/src/ai/skill.zod.ts:80ask surface 注释为 "the open-source/free surface",这与 cloud ADR-0025(ask/build 的 in-product 运行时 = cloud-only)相矛盾。本 PR 文档遵循 ADR-0025 口径;该 spec 注释疑似需要统一,建议单独跟进。

🤖 Generated with Claude Code

https://claude.ai/code/session_01LHQscZJ8NvXceSmsPNdTZd


Generated by Claude Code

…tro pages

This is the open-source (community) documentation site. Two changes:

1. Remove genuinely cloud-only introduction pages (verified absent from the open
   framework's packages/):
   - ai/chatbot-integration.mdx — in-product chat / HITL wiring on
     @objectstack/service-ai (cloud, ADR-0025).
   - deployment/cloud-artifact-api.mdx — the Cloud control-plane artifact HTTP
     contract.
   Nav (meta.json) and the two inbound cross-links (ai/index,
   deployment/publish-and-preview) are updated so nothing dangles.

2. Reframe docs that positioned an open capability as cloud/Enterprise-only. The
   open framework ships the whole AI stack except the in-product chat runtime:
   - AI: agents/tools/skills are typed metadata (defineAgent/defineTool/defineSkill,
     @objectstack/spec/ai); data query and action invocation run through
     @objectstack/mcp (BYO-AI, RLS-governed); the Knowledge/RAG stack
     (service-knowledge + knowledge-memory / knowledge-ragflow + embedder-openai)
     is open. Only the in-product ask/build chat runtime (@objectstack/service-ai,
     /api/v1/ai/*) is cloud/Enterprise — now clearly labeled, not the default
     narrative. Touches ai/index, agents, actions-as-tools, knowledge-rag,
     natural-language-queries. Also corrects the actions "explicit opt-in" framing:
     the open MCP path filters by permission, not the cloud-only ai.exposed gate.
   - Auth: OIDC + SAML SSO ship in the open @objectstack/plugin-auth via
     @better-auth/sso (Setup → SSO Providers, no code); sso.mdx no longer implies
     they require an enterprise package.

Every open/cloud claim is backed by packages/ (or its absence): @objectstack/mcp,
service-knowledge, knowledge-*, embedder-openai, and plugin-auth SSO/SCIM are
present; @objectstack/service-ai is not. Also fixed a fabricated MCP wiring API in
the reframed examples (MCPServerPlugin.configure(...) → the real
`new MCPServerPlugin({ transport, autoStart })`).

Note for maintainers: packages/spec/src/ai/skill.zod.ts:80 calls the `ask` surface
"the open-source/free surface", which contradicts cloud ADR-0025 (ask/build
in-product runtime = cloud-only). These docs follow ADR-0025; the spec comment
likely needs reconciling.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LHQscZJ8NvXceSmsPNdTZd
@vercel

vercel Bot commented Jul 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jul 5, 2026 4:50pm

Request Review

@os-zhuang os-zhuang added documentation Improvements or additions to documentation skip-changeset PR has no user-facing published change; bypasses the changeset gate labels Jul 5, 2026 — with Claude
@github-actions github-actions Bot added the size/l label Jul 5, 2026
@os-zhuang
os-zhuang marked this pull request as ready for review July 5, 2026 16:56
@os-zhuang
os-zhuang merged commit 97ad570 into main Jul 5, 2026
20 of 21 checks passed
@os-zhuang
os-zhuang deleted the claude/docs-review-cleanup-6zv1ee branch July 5, 2026 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/l skip-changeset PR has no user-facing published change; bypasses the changeset gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants