Skip to content

Commit 1917426

Browse files
os-zhuangclaude
andcommitted
docs(capabilities): expand the business tour into a full section
'What Can It Do?' grows from one page into a Learn-section folder of ten business-language pages — data, views, forms & quality, automation, approvals, permissions, analytics, AI, integrations & everyday work, and a requirements one-pager template. Each page keeps three anchors: business scenarios, an 'In HotCRM' pointer at the running example, and a 'For developers' cross-link into the technical Build docs. The index becomes a card directory; new pages drop hand-written H1s (frontmatter title renders them). URL /docs/platform-capabilities → /docs/capabilities (page introduced in this PR, so no redirect debt). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 9024793 commit 1917426

18 files changed

Lines changed: 389 additions & 76 deletions

content/docs/build-without-code.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Build Without Code
33
description: What admins and business analysts can do visually in Console, Studio, and Setup — and how that stays in sync with metadata written as code
44
---
55

6-
# Build Without Code
76

87
You do not have to write metadata files to build on this platform. **Console**, **Studio**, and **Setup** cover the run–design–administer loop visually — and everything you do there produces *the same metadata artifacts* a developer would write by hand, checked by the same validation gate. Clicking and coding are two editors over one definition, so a team can freely mix both.
98

content/docs/capabilities/ai.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: AI Under Governance
3+
description: Ask questions and get charts, let AI act under the same permissions and audit as people, and connect your own agents over MCP
4+
---
5+
6+
7+
The platform's rule for AI is simple: **an agent gets exactly the access its user has — never more — and every action is audited.** AI here is not a bolt-on chat window; it operates through the same typed, permission-checked surface as the UI and the API.
8+
9+
## Ask, and get answers with charts
10+
11+
Ask in natural language — *"top ten opportunities by amount in the East region this quarter?"* — and get the result as data **and as a chart**, inline. No SQL, no export-to-spreadsheet detour.
12+
13+
## Let AI do the work
14+
15+
Conversationally create and update records, run actions, and drive processes: *"convert this lead; the account name is Acme Ltd."* Risky operations ask for confirmation first, or can be routed into a human-review inbox so AI proposes and people approve.
16+
17+
## Knowledge answers
18+
19+
Connect product sheets, playbooks, and policy docs, and the assistant answers from **your** knowledge — with the same permission filtering on what each person may retrieve.
20+
21+
## Bring your own agent (MCP)
22+
23+
Every deployment exposes its objects and permitted actions as an **MCP server** — on by default at `/api/v1/mcp`. Point Claude or any MCP client at your app and that agent can inspect and operate it, under the signed-in user's permissions, with every call audited. Your app is AI-operable the day it ships, for free.
24+
25+
> **In HotCRM**: two copilots ship ready — a **sales copilot** (lead scoring, customer-360 summaries, email drafting, revenue forecasting) and a **service copilot** (case triage, live-data Q&A) — built from six reusable AI skills. Swap the skills to retarget them at your own domain.
26+
27+
*The conversational UI is part of the commercial runtime; the MCP surface — bring-your-own-agent — ships in open source.*
28+
29+
**For developers**: agents, skills, and MCP configuration in [AI](/docs/ai).
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Analytics & Dashboards
3+
description: ~20 chart families, period-over-period comparison, runtime filters, TV display pages, four report shapes, and scheduled email digests
4+
---
5+
6+
7+
The executive cockpit and the ops detail report are both configured, not built. Data is live, and permissions apply inside every chart — each viewer sees only the numbers they are allowed to see.
8+
9+
## Dashboards
10+
11+
Compose from roughly twenty chart families:
12+
13+
- **Single values**: KPI tiles, gauges, progress rings — total pipeline, quarter-to-date closed, target attainment.
14+
- **Comparisons**: bar and column by stage, rep, or product line.
15+
- **Trends**: line and area over time.
16+
- **Composition**: pie, donut, **funnel** (stage conversion), treemap.
17+
- **Detail**: tables and pivot tables.
18+
19+
Dashboard extras that matter in practice:
20+
21+
- **Period-over-period in one switch** — KPI tiles grow a "+12% vs. last period" arrow; trend charts overlay the prior period as a dashed line.
22+
- **Runtime filters across the top** — quarter, owner, lead source; every widget follows the selection.
23+
- **Full-bleed display pages** — dark, TV-styled dashboards for the office screen, with auto-fitting KPI and chart layout.
24+
- **One metric, one definition** — indicators like "closed revenue" are defined once in shared datasets, so two dashboards can never disagree about what the number means.
25+
26+
## Reports
27+
28+
Four shapes — **tabular** (detail rows), **summary** (grouped totals), **matrix** (regions × quarters), and **joined** (multi-object) — with runtime filters and export. **Scheduled email digests** deliver a report daily or weekly: the Monday-morning sales report writes itself.
29+
30+
> **In HotCRM**: four dashboards (executive, sales, service, CRM overview) and six reports (lead, opportunity, account, case, churn), fed by six shared datasets covering accounts, contacts, leads, opportunities, products, and cases. The executive dashboard carries quarter and owner filters plus the funnel and trend widgets described above.
31+
32+
**For developers**: dashboards, charts, and reports as metadata in [Views & Apps](/docs/ui/dashboards).
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Approvals
3+
description: Eight ways to pick approvers, four decision modes including group sign-off, record locking, overdue escalation, and send-back-for-revision
4+
---
5+
6+
7+
Discounts, contracts, spend — anything that needs a human "yes" becomes an approval step in a flow, replacing the group-chat shoulder tap with a tracked, enforceable decision.
8+
9+
## Who approves — eight resolution styles
10+
11+
A specific person · everyone holding a position (e.g. sales managers) · the submitter's direct manager · a team · a department (optionally including sub-departments) · organization leadership · **a person named on the record itself** (e.g. the "regional director" field) · a shared queue (first responder claims it).
12+
13+
## How it passes — four decision modes
14+
15+
| Mode | Rule | Fits |
16+
|---|---|---|
17+
| First response | Any one approval passes it | Routine low-value requests |
18+
| Unanimous | Everyone must approve | Major contracts |
19+
| M-of-N quorum | e.g. 3 of 5 | Committee reviews |
20+
| **Group sign-off** | Each group must independently approve | Finance *and* legal must each clear it |
21+
22+
Any rejection ends the chain immediately. Multi-level ladders (manager → director → VP) are just chained steps, and conditions route by amount — under 100k ends at manager, over 500k adds the VP.
23+
24+
## Process controls
25+
26+
- **Record locking** while pending — no editing the deal mid-approval (configurable).
27+
- **Status mirrored onto the record** — lists can filter by "pending approval".
28+
- **Overdue escalation (SLA)** — after N hours: reassign, auto-approve, auto-reject, or notify, your choice.
29+
- **Send back for revision** — return to the submitter for changes and a fresh round, distinct from a hard reject; retry count can be capped.
30+
- **An approvals inbox** for batch processing, and a permanent audit trail of who decided what, when, and why.
31+
32+
> **In HotCRM**: the opportunity approval flow routes large or deep-discount deals to management, mirrors the outcome onto the record, and locks it while pending.
33+
34+
**For developers**: approval nodes and approver metadata in [Automation → Approvals](/docs/automation/approvals).
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Automation — Processes That Run Themselves
3+
description: Five trigger styles, visual flow diagrams, notifications, branching, loops, waits, and external calls — the work nobody should have to remember
4+
---
5+
6+
7+
Anything that today relies on someone remembering — reminders, hand-offs, escalations, follow-ups — becomes a **flow**: a visual diagram the platform executes reliably, with a run history you can inspect.
8+
9+
## Five ways a flow starts
10+
11+
1. **When records change** — created, updated, or deleted, with conditions that can compare old vs. new values (*"amount crossed 500k"* fires once, not on every unrelated edit).
12+
2. **On a schedule** — every morning at 8, every Monday, the 1st of each month.
13+
3. **Relative to record dates***30 days before contract expiry*, *7 days after signing*, evaluated per record.
14+
4. **Launched by a person** — button-triggered wizards like "Convert lead".
15+
5. **Called by an external system** — your website or ERP pings an endpoint and the flow runs.
16+
17+
## What flows can do
18+
19+
Create, update, and delete records · send notifications (in-app, email, chat) · branch on conditions · run steps in parallel and join · loop over a set of records · wait for a duration or a signal · call external services · invoke shared sub-flows.
20+
21+
## Reliability you can see
22+
23+
Flows are enabled or disabled with a switch and start life as drafts. Every execution leaves a run record — which node, what outcome — and the diagram in Studio *is* the executable logic, so documentation never drifts from behavior.
24+
25+
> **In HotCRM**: sixteen flows run the whole sales-and-service motion —
26+
> lead auto-assignment · lead conversion · opportunity approval · stagnation alerts · won announcements · quote generation · quote expiry reminders · contract expiration · renewal task creation · case escalation · case SLA monitoring · CSAT follow-up · campaign enrollment · campaign completion · new-contact welcome · task due reminders.
27+
> Open any of them in Studio's Automation pillar to read the diagram.
28+
29+
**For developers**: triggers, nodes, and flow metadata in [Automation](/docs/automation).

content/docs/capabilities/data.mdx

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Manage Business Data
3+
description: Objects, 40+ field types, auto-computed fields, and relationships — every spreadsheet you run the business on, structured and governed
4+
---
5+
6+
7+
Every kind of record your team tracks — accounts, contacts, leads, opportunities, orders, tickets — becomes an **object**: a structured, permission-controlled, connected table you can create and change at any time. Columns become **fields**, and adding or changing a field is a configuration change, not a development request.
8+
9+
## Field types for everything you record
10+
11+
| You want to record | Field types |
12+
|---|---|
13+
| Names, notes, long text | Text / textarea / rich text |
14+
| Money, quantities, ratios | Currency amount / number / percent |
15+
| Dates and times | Date / datetime / time |
16+
| Choices | Single select (colored options) / multi-select / radio / checkbox group |
17+
| Yes-or-no | Boolean toggle |
18+
| People | Owner / user pickers |
19+
| Links to other records | Lookup (opportunity → account) / master-detail (opportunity → line items) |
20+
| Ratings and progress | Star rating / progress bar / slider |
21+
| Contact details | Phone / email / URL |
22+
| Places | Address / map location |
23+
| Images and files | Image / attachment / avatar / audio / video |
24+
| Signatures and codes | E-signature / QR code / barcode |
25+
| Labels | Tags |
26+
| Document numbers | Auto-number (e.g. `SO-2026-0001`) |
27+
28+
## Fields that compute themselves
29+
30+
- **Formula fields** derive values automatically: *expected revenue = amount × probability*, *days until close date*. When inputs change, the value updates — nobody maintains it.
31+
- **Roll-up summaries** total child rows onto the parent: an opportunity's product total is always the sum of its line items, recalculated the moment a line changes.
32+
33+
## Records that connect
34+
35+
- **One-to-many**: an account has many contacts and opportunities; the account page shows them all as related lists.
36+
- **Master-detail**: an opportunity owns its product line items — edited inline as a grid inside the opportunity form, saved in one step, and removed with their parent.
37+
- **Many-to-many**: contacts participate in many campaigns; campaigns have many members.
38+
- **Hierarchies**: product category trees, org structures, parent-subsidiary account chains.
39+
40+
## Quality built into the data itself
41+
42+
Uniqueness, required-ness, searchability, and history tracking are per-field switches. Records support soft delete (a recycle bin, not permanent loss), cloning, and full change history when tracking is on.
43+
44+
> **In HotCRM**: 15 business objects model the full sales-and-service domain — lead, account, contact, opportunity (+ line items), quote (+ line items), product, contract, case, knowledge article, campaign (+ members), task, and forecast. Open any of them in Studio to see these field types in real use.
45+
46+
**For developers**: the same ground with full technical depth in [Data Modeling](/docs/data-modeling).
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Forms & Data Quality
3+
description: Sectioned and wizard forms, validation at the moment of entry, legal stage transitions, and public forms for anonymous submission
4+
---
5+
6+
7+
Bad data is cheapest to stop at the moment it is typed. Forms, validation rules, and stage machines catch problems on save — not at month-end reconciliation.
8+
9+
## Forms that fit the work
10+
11+
- **Sectioned forms**: fields grouped under "Basics / Commercial terms / Internal notes".
12+
- **Multi-step wizards**: complex entry split into steps — e.g. lead conversion: confirm the account → create the opportunity → carry over products.
13+
- **Conditional visibility**: show or require fields only when relevant — *"Closed-won" makes "Contract date" visible and required; "Closed-lost" requires a loss reason.*
14+
- **Inline line items**: master-detail children (opportunity products) edited as a grid inside the parent form, saved atomically.
15+
- **Defaults**: owner defaults to the current user, dates default to today, values can derive from context.
16+
17+
## Validation that actually blocks bad saves
18+
19+
- **Required fields** — cannot save without them.
20+
- **Format checks** — email, phone, and code patterns rejected inline.
21+
- **Cross-field logic***end date cannot precede start date; discounts above 40% cannot be saved* (route exceptions through an [approval](/docs/capabilities/approvals) instead).
22+
- **Stage machines** — declare which status transitions are legal (*negotiation → won or lost only; no skipping from first-contact to won*). The runtime enforces this on every write — API and import included — so process discipline does not depend on memory.
23+
24+
## Public forms (web-to-lead)
25+
26+
Publish a form to a URL and put it on your website, a landing page, or a QR code. Anonymous visitors submit; each submission lands as a record (typically a lead) containing only the fields you chose to expose. Pair it with [automation](/docs/capabilities/automation) to assign and notify instantly.
27+
28+
> **In HotCRM**: the lead-conversion wizard, opportunity stage machine, and a guest-portal permission profile for public submission are all wired in — try saving an opportunity backwards through its stages and watch the platform refuse.
29+
30+
**For developers**: [validation and state machines](/docs/data-modeling/validation) in Data Modeling.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: What Can It Do?
3+
description: The platform's capabilities in business language — data, views, automation, approvals, permissions, analytics, AI, integrations — each with a real CRM as the running example
4+
---
5+
6+
7+
This section answers one question: **"can the platform do the business feature I need?"** — in business language, with no code. Everything described here ships in the platform today, and the official **HotCRM** template (one-click install from the Marketplace) implements all of it end to end — every page below points at the running example, so nothing is hypothetical.
8+
9+
If you are a developer, the [Build sections](/docs/data-modeling) cover the same ground with full technical depth; each page here links to its technical counterpart.
10+
11+
## The capabilities
12+
13+
<Cards>
14+
<Card href="/docs/capabilities/data" title="Manage Business Data" description="Objects, 40+ field types, formula and roll-up fields, relationships from lookups to hierarchies" />
15+
<Card href="/docs/capabilities/views" title="Views — See Data Your Way" description="Nine lenses over the same records: table, kanban, calendar, gantt, map and more — plus saved filters and global search" />
16+
<Card href="/docs/capabilities/forms" title="Forms & Data Quality" description="Wizards, conditional fields, validation on save, legal stage transitions, public web-to-lead forms" />
17+
<Card href="/docs/capabilities/automation" title="Automation" description="Five trigger styles and visual flows: reminders, hand-offs, escalations, and scheduled work that runs itself" />
18+
<Card href="/docs/capabilities/approvals" title="Approvals" description="Eight approver styles, four decision modes including group sign-off, locking, SLA escalation, send-back" />
19+
<Card href="/docs/capabilities/permissions" title="Permissions — Who Sees What" description="Four layers from object capability to per-field visibility, five data-depth scopes, audit and explain" />
20+
<Card href="/docs/capabilities/analytics" title="Analytics & Dashboards" description="~20 chart families, period-over-period, runtime filters, TV display pages, reports and email digests" />
21+
<Card href="/docs/capabilities/ai" title="AI Under Governance" description="Ask questions and get charts; AI acts under the same permissions and audit as people; bring your own agent over MCP" />
22+
<Card href="/docs/capabilities/integrations" title="Integrations & Everyday Work" description="Import/export, generated APIs, webhooks, connectors, federated databases, marketplace templates, languages" />
23+
<Card href="/docs/capabilities/request-template" title="How to Request Features" description="A one-page template that turns business needs into configuration — hand it to your team or an AI agent" />
24+
</Cards>
25+
26+
## See it live
27+
28+
```bash
29+
npm create objectstack@latest my-app && cd my-app
30+
npx os dev --ui # → http://localhost:3000/_console/
31+
```
32+
33+
Install **HotCRM** from the Marketplace: 15 business objects, 16 automation flows, 6 permission profiles, 4 dashboards, 6 reports, and 2 AI copilots — every page in this section names where to look inside it.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Integrations & Everyday Work
3+
description: Import/export, generated APIs, webhooks, connectors, federated external databases, marketplace templates — plus collaboration and languages
4+
---
5+
6+
7+
A business system earns its keep by fitting into the systems — and habits — you already have.
8+
9+
## Connect other systems
10+
11+
- **Bulk import / export** — move spreadsheets in and out; migrate the old system's accounts in one pass.
12+
- **Generated REST APIs** — every object gets standard endpoints automatically, so your website, mini-program, or ERP reads and writes through the same permission gate as people.
13+
- **Webhooks out** — data changes notify external systems (*deal won → billing system opens an invoice*).
14+
- **Triggers in** — external systems start platform [flows](/docs/capabilities/automation).
15+
- **Connectors** — ready-made Slack and generic REST connectors drop into flows.
16+
- **Federated external databases** — point at an existing database and query it in place: no migration, visible in views, usable in flows.
17+
- **Marketplace templates** — install complete apps (HotCRM among them) with one click: objects, views, flows, dashboards, and seed data included, then customize in Studio.
18+
- **Deploy anywhere** — cloud or fully self-hosted; your data and your app definition stay yours.
19+
20+
## Everyday collaboration
21+
22+
Discussion threads on every record (@-mention colleagues in context) · file attachments · an activity timeline of key changes · a unified notification center for approvals, flow alerts, and mentions · full change history on tracked objects · a recycle bin for soft-deleted records · one-click record cloning · recently-visited lists.
23+
24+
## Languages
25+
26+
Interface text — labels, options, messages — is translatable per language, and each user reads the UI in their own locale. Coverage reporting shows what remains untranslated before launch.
27+
28+
> **In HotCRM**: the interface ships in four languages (English, Chinese, Japanese, Spanish); the Slack connector and web-to-lead intake demonstrate both directions of integration.
29+
30+
**For developers**: [API & SDK](/docs/api), [connectors and webhooks](/docs/automation), and [translations](/docs/ui/translations).
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"title": "What Can It Do?",
3+
"pages": [
4+
"index",
5+
"data",
6+
"views",
7+
"forms",
8+
"automation",
9+
"approvals",
10+
"permissions",
11+
"analytics",
12+
"ai",
13+
"integrations",
14+
"request-template"
15+
]
16+
}

0 commit comments

Comments
 (0)