Skip to content

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

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationpm:dispatchedDispatched to a dev agent by /pm-dispatchprio:p0Blocking the current release goal — do first

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions