Skip to content

Docs alignment: README/copilot pages describe retired agents; archived Salesforce comparison lacks a retired-architecture banner #589

Closed

Description

@os-zhuang

Found during a full business/platform-capability review of the app (2026-08-02). All items are pure docs changes; none touch metadata.

Problems

  1. README.md:60 contradicts README.md:131 in the same file. Line 60 claims "2 AI agents (sales-copilot, service-copilot), … 20 flows, … 5 sharing rules"; line 131 correctly says skills-only surface, no agents and 23 flows. Reality: 0 agents, 6 skills, 23 flows, 9 sharing rules.
  2. content/docs/ai-copilot/{sales,service}-copilot.mdx (en / zh-Hans / zh-Hant — 6 published pages) describe copilot personas retired in refactor(ai): skills-only AI surface — real Actions instead of 10 fictional tools, retire the two agents #512, e.g. "It lives in the right-side chat panel and as inline buttons on lead, contact, account, and opportunity pages." The underlying capability survives as 6 skills attached to the platform ask agent — the pages should be rewritten as skill docs, not deleted.
  3. docs/archive/2026-02/SALESFORCE_FEATURE_COMPARISON.md describes a completely different retired architecture (~148 objects, 13 packages; sla_policy/queue/email_to_case/pricebook marked "✅ Implemented" — none exist in the current tree) and claims 95% Salesforce parity. It is archived but carries no disclaimer, so it actively misleads anyone evaluating the repo. Add a prominent "describes a retired pre-2.x architecture; see README for the current product" banner.
  4. docs/ARCHITECTURE.md is stale: mermaid references src/agents (deleted) and src/cubes (never existed); manifest table says version 1.0.5 (actual 2.2.2); requires list still includes ai (removed in 2.2.0).

Note: the objectstack repo has the same class of drift about HotCRM (content/docs/getting-started/examples.mdx invents src/agents, src/apis, src/rag, a Slack connector; capabilities/{index,ai,integrations}.mdx claim "2 copilots"). That is upstream work and should be filed there — this issue covers only the hotcrm side.

Acceptance

  • One consistent set of numbers (objects/flows/skills/sharing rules) across README and content/docs, matching objectstack.config.ts.
  • No published page describes sales_copilot/service_copilot as shipped agents.
  • The archived comparison doc opens with a retired-architecture banner.

Activity

  1. added
    documentationImprovements or additions to documentation
    pm:queueReady for the PM dispatch loop
    pm:dispatchedDispatched to a dev agent by /pm-dispatch
    and removed
    pm:queueReady for the PM dispatch loop
    on Aug 2, 2026
  2. self-assigned this
    on Aug 2, 2026
  3. os-zhuang commented on Aug 2, 2026

    @os-zhuang
    ContributorAuthor

    认领:PM 循环第 2 轮
    会话:session_019SS7C5SXpniKeCApxgARyf
    分支:claude/issue-589-docs-alignment
    Worktree:hotcrm-issue-589


    Generated by Claude Code

  4. os-zhuang commented on Aug 2, 2026

    @os-zhuang
    ContributorAuthor

    ✅ 验收通过(PM 循环第 2 轮):PR #611 已进入合并队列。

    交付内容:README 与 objectstack.config.ts 实际注册数量对齐(0 agents / 6 skills / 23 flows / 9 sharing rules,数字直接对照 pnpm validate 输出核验);六个 copilot 文档页在原 URL 改写为 skill 文档(内容取自真实的 triggerConditions 与所调 action,连带修正 glossary、customization 指南及全部入链标签);归档的 Salesforce 对比文档加「已废弃架构」横幅;ARCHITECTURE.md 清理 src/agents/src/cubes 幻影目录、版本号 1.0.5→2.2.2。live-schema.* 与 demo 脚本按边界留给 #606。CI 8/8 全绿(含 link-check 与 docs-drift pin)。

    范围外发现已开单 #612(源码注释残留、RELEASE_STRATEGY 版本号第三处漂移、约 90 处 "Sales/Service Copilot" 产品昵称的措辞决策)。


    Generated by Claude Code

  5. added
    priority:p0Critical: blocker, must ship before MVP
    and removed on Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationpm:dispatchedDispatched to a dev agent by /pm-dispatchpriority:p0Critical: blocker, must ship before MVP

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions