docs: align README/copilot pages with the shipped skills-only surface (#589) - #611
Merged
Conversation
…#589) The README claimed "2 AI agents (sales-copilot, service-copilot), 20 flows, 5 sharing rules" seventy lines above a layout block that correctly described a skills-only surface with 23 flows. Both now state the numbers that objectstack.config.ts actually registers: 0 app-owned agents, 6 skills, 23 flows, 9 sharing rules, 8 datasets. Rewrite the six published copilot pages (en/zh-Hans/zh-Hant) as skill docs at their existing URLs. The personas were retired in #512; the capability ships as six skills on the platform `ask` assistant. Activation is documented from each skill's real triggerConditions, and writes are named as the HotCRM actions the skills call (convert_lead, schedule_followup, escalate_case, close_case) instead of inline buttons that do not exist. Follow the rename through the AI Copilot index, the Skills and Knowledge Bases pages, the glossary's "Agent (AI)" entry, the customization guide (which told developers to edit the long-deleted src/agents/sales-copilot.agent.ts) and every inbound link label. live-schema.* is left untouched — it is #606's scope. Banner the archived Salesforce comparison: it describes a ~148-object, 13-package architecture and marks sla_policy/queue/email_to_case/pricebook as implemented when none exist, so its "~95% parity" headline misled anyone evaluating the repo. Correct docs/ARCHITECTURE.md: drop the deleted src/agents and the never-created src/cubes from the diagram, 1.0.5 -> 2.2.2, and remove the `ai` capability from `requires` (removed in 2.2.0 because it is fail-fast under ObjectStack 16). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019SS7C5SXpniKeCApxgARyf
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
github-actions
Bot
added
the
documentation
os-zhuang
marked this pull request as ready for review
August 2, 2026 11:32
This was referenced Aug 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #589
Description
纯文档变更，不触碰任何 metadata。本 PR 解决四类文档漂移：README 自相矛盾的数量、把已退役 agent 当作在售能力描述的已发布页面、缺少免责声明的归档对比文档，以及过时的架构文档。
所有数字均以当前
origin/main的objectstack.config.ts为准，并由pnpm validate的输出复核。Type of Change
Related Issues
Fixes #589
Related to #512 (agent 退役), #607 (
defaultAgent改绑平台ask), #606 (live-schema 演示路径 —— 不在本 PR 范围)Changes Made
1. README 数字统一
README.md:8和:60声称 "2 AI agents (sales-copilot, service-copilot)、20 flows、5 sharing rules"，而同一文件:131的仓库结构块正确地写着 skills-only surface, no agents 和 23 flows。真实数字取自objectstack.config.ts：ask）pnpm validate输出复核：15 Objects · 23 Flows · 4 Dashboards · 13 Actions · 12 Positions · 6 Permissions。2. copilot 页面改写为技能文档（6 个页面 + 关联页）
ai-copilot/{sales,service}-copilot.mdx（en / zh-Hans / zh-Hant）此前描述的是 #512 已退役的两个人格化 agent，例如 "It lives in the right-side chat panel and as inline buttons on lead, contact, account, and opportunity pages" —— 那些内联按钮并不存在。按 issue 的要求改写而非删除，URL 保持不变（
/docs/ai-copilot/sales-copilot等），避免站内外链接失效；仅title改为 Sales Skills / Service Skills / 销售技能 / 銷售技能。新内容全部有源可依：triggerConditions——lead_qualification→crm_lead；revenue_forecasting→crm_opportunity或dashboard；case_triage→crm_case；live_data/email_drafting/customer_360无限制。convert_lead、schedule_followup、escalate_case、close_case），取代原先虚构的 🎯 Qualify / 🚦 Triage / 📚 Find articles 按钮。连带修正的页面：
ai-copilot/index（"两个 Copilot" → 一个平台助手 + 六项技能的两种分组）、ai-copilot/skills、ai-copilot/knowledge-bases的 Used by 列、reference/glossary的 Agent (AI) 条目（原文直接断言 "The Sales Copilot and Service Copilot are agents"）、customization/ai-skills（原文让开发者去编辑早已删除的src/agents/sales-copilot.agent.ts，现改为导出 + 加入allSkills），以及sales/、service/、analytics/、guides/、getting-started/中全部指向这两页的链接文案。三语言同步。content/docs/ai-copilot/live-schema.*与scripts/wow1-live-schema.sh一行未动 —— 那是 #606 的范围。本 PR 的改写没有新增与其冲突的断言：新文案只陈述"能力以 skills 形式挂在平台助手上"这一 #607 已落地的事实。3. 归档对比文档加退役横幅
docs/archive/2026-02/SALESFORCE_FEATURE_COMPARISON.md描述的是 ~148 个对象、13 个 package 的另一套架构，把sla_policy/queue/email_to_case/pricebook标为"✅ Implemented"（当前树中一个都不存在），并宣称 ~95% Salesforce 功能对等。文件虽已归档但无任何提示，任何评估本仓库的人都会被误导。现以醒目横幅开头，说明它描述的是 pre-2.x 退役架构，并给出当前产品的真实规模与 README / ARCHITECTURE 的指引。4.
docs/ARCHITECTURE.md去陈旧化src/agents与从未存在的src/cubes，Analytics 分支改为src/datasets, src/dashboards, src/reports。1.0.5→2.2.2，并补上engines.protocol。requires列表移除ai（2.2.0 移除；ObjectStack 16 下它是 fail-fast 能力，声明会直接让开源版objectstack start启动中止），并附上原因说明。roles→positions，以及指向不存在的src/sharing/role-hierarchy.ts—— 按 ADR-0090 D3 改为src/sharing/positions.ts并说明层级已移除。Testing
pnpm test：Test Files 34 passed (34)，Tests 652 passed | 1 skipped (653)，含test/docs-drift.test.ts的仓库树漂移守卫（TREE_DOCS覆盖 README.md 与 docs/ARCHITECTURE.md）pnpm lint：1 warning(s), 13 suggestion(s)，与 base 一致，无新增pnpm build：✓ Build complete，dist/objectstack.json (1014.1 KB)pnpm validate：✓ Validation passed (1074ms)pnpm typecheck：无输出（通过）TREE_DOCS文件Checklist
.changeset/docs-align-retired-agents.md（patch）Additional Notes
范围之外的发现，已单独立 issue #612（未在本 PR 修复，遵循 Prime Directive #10）：
objectstack.config.ts:76的注释仍写着 "the two agents + skills still validate" —— 同一类漂移，但属于源码文件而非文档。docs/RELEASE_STRATEGY.md:14仍写Current version | 1.0.5（实际 2.2.2）。content/docs/下另有约 39 个产品页面（sales / service / revenue / reference / whats-new）在散文中把 "Sales Copilot" / "Service Copilot" 当作助手昵称使用（共约 90 处）。issue Docs alignment: README/copilot pages describe retired agents; archived Salesforce comparison lacks a retired-architecture banner #589 的问题 2 明确只列举了ai-copilot/{sales,service}-copilot.mdx这 6 个页面，且这批文件与 Wow #1 demo docs + script still POST the retiredsales_copilotagent #606 的范围有重叠，因此把全站改名作为独立议题另行处理更安全。这些散文并未断言存在名为sales_copilot的 agent，因此本 issue 的验收标准"没有已发布页面把 sales_copilot/service_copilot 描述为在售 agent"已经满足。content/docs/whats-new.mdx的 "What's in v1.0" 小节提到 Sales Copilot —— 该节是历史发布记录，与 CHANGELOG 同属史料，故保留（仅把中文版首屏现在时的营销文案 "向 Sales Copilot 询问" 与英文版对齐为"向助手询问"）。