Skip to content

Commit 96a077c

Browse files
authored
Merge pull request #100 from objectstack-ai/claude/issue-79-retire-console-name
docs: retire "Console" as the end-user surface name; keep Setup for administration
2 parents b1c793c + adbcafc commit 96a077c

48 files changed

Lines changed: 171 additions & 174 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/docs/build/agents.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export const tier1Support = defineAgent({
4747
});
4848
```
4949

50-
Or in Console: **Console → Agents → New Agent**.
50+
Or in the UI: **Agents → New Agent**.
5151

5252
Or — and this is the point — say to the AI Builder:
5353

@@ -114,7 +114,7 @@ POST /api/v1/ai/chat { context: { appName: 'crm' }, ... }
114114

115115
When `context.appName` resolves to an app that declares a
116116
`defaultAgent`, the runtime auto-selects that agent — the user never
117-
picks from a list. Console's built-in AI panel uses this. The runtime
117+
picks from a list. The built-in AI panel uses this. The runtime
118118
resolves:
119119

120120
1. The **default agent** for the active app (the app's `defaultAgent`),

‎content/docs/build/ai-builder.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: AI Builder
3-
description: The in-Console chat that turns plain-language requirements into running metadata.
3+
description: The built-in chat that turns plain-language requirements into running metadata.
44
---
55

66
The AI Builder is the **primary way customers extend ObjectOS**. Open
7-
Console, talk to the assistant in plain language, and it builds the
7+
ObjectOS, talk to the assistant in plain language, and it builds the
88
metadata for you — packages, objects, fields, actions, flows. Every
99
change is queued in a Human-in-the-Loop (HITL) approval list before it
1010
goes live.
@@ -33,7 +33,7 @@ AI: ✓ Package created
3333
Done. Try it: /support_ticket
3434
```
3535

36-
You now have a working ticketing app — REST endpoints, Console views,
36+
You now have a working ticketing app — REST endpoints, generated views,
3737
audit log entries, permission checkpoints, the works. No file was
3838
edited; no restart happened.
3939

@@ -132,11 +132,11 @@ Verified patterns, with one-liner prompts:
132132
| Translation | *"Translate the support_ticket labels and picklists to Spanish."* |
133133

134134
If the AI can't do it, it says so — and points you at the manual path
135-
(usually a 30-line `*.ts` file or a Console form).
135+
(usually a 30-line `*.ts` file or a form).
136136

137137
## Live preview
138138

139-
After each approved change, Console re-renders the affected views in
139+
After each approved change, ObjectOS re-renders the affected views in
140140
place. No reload needed. The runtime hot-loads the touched package's new
141141
metadata; subsequent requests use it.
142142

‎content/docs/build/ai-skills.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: IDE Skills (Claude Code / Cursor / Copilot)
33
description: Install ObjectOS skills into your coding agent so Claude Code, Cursor, Copilot, Codex and friends know how to author ObjectOS metadata correctly.
44
---
55

6-
The [AI Builder](./ai-builder) lives inside Console and talks to your
6+
The [AI Builder](./ai-builder) lives inside ObjectOS and talks to your
77
tenant's database. But sometimes you want the same domain knowledge
88
inside your IDE — when you're hand-editing `*.object.ts`, designing a
99
flow, or asking Cursor to write a CEL predicate.
@@ -89,7 +89,7 @@ disappear once the skills are installed.
8989

9090
| | [AI Builder](./ai-builder) | IDE Skills |
9191
|:--|:--|:--|
92-
| Where it runs | Console (browser) | Your IDE / coding agent |
92+
| Where it runs | Your browser | Your IDE / coding agent |
9393
| What it changes | Live metadata in your tenant | Files in your repo |
9494
| Acts on behalf of | Your end users / admins | Your developers |
9595
| Approval model | HITL queue (`ai:approve`) | Pull request review |
@@ -108,6 +108,6 @@ helpers, and metadata vocabulary.
108108

109109
## Related
110110

111-
- [AI Builder](./ai-builder) — the in-Console counterpart
111+
- [AI Builder](./ai-builder) — the in-browser counterpart
112112
- [Agents](./agents) — declare server-side agents that run *inside* ObjectOS
113113
- [Templates](./templates) — every official template is built with these skills loaded

‎content/docs/build/automation/approvals.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ reject, reassign, send-back for revision (`/revise`), request-info, remind,
287287
recall, resubmit — is declared as `type: 'api'` actions on
288288
`sys_approval_request`, with typed params, pending-only visibility gates, and
289289
submitter-vs-approver predicates (e.g. `record.submitter_id == ctx.user.id`).
290-
The Console approvals inbox renders those declared actions instead of
290+
The approvals inbox renders those declared actions instead of
291291
hand-written buttons, so new decision capabilities ship as metadata — no
292292
client release required.
293293

‎content/docs/build/automation/flows.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Declarative business logic — described to AI or written in TypeSc
66
Flows are how you express business logic without writing a server.
77
Every flow is declarative metadata that the runtime executes — same
88
as objects and views. That means flows show up in `os diff`, the
9-
audit log, Console's flow builder, and the [AI Builder](/docs/build/ai-builder)
9+
audit log, the flow builder, and the [AI Builder](/docs/build/ai-builder)
1010
all at once.
1111

1212
Most customers create flows by asking the AI:
@@ -33,7 +33,7 @@ export default defineStack({
3333
| **Autolaunched** | A record change (insert/update/delete) | "Send welcome email when user registers" |
3434
| **Scheduled** | Cron expression or interval | "Mark stale tasks every night at 2am" |
3535
| **Time-relative** *(16.0)* | A date field's proximity to today, via a daily sweep | "Remind me 60 days before the contract ends" |
36-
| **Manual** | User clicks a button in Console, or an API call | "Approve invoice" actions |
36+
| **Manual** | User clicks a button, or an API call | "Approve invoice" actions |
3737

3838
## Autolaunched: react to a record change
3939

@@ -202,7 +202,7 @@ export const approveInvoice = defineFlow({
202202
});
203203
```
204204

205-
Surface it in Console as a button on the Invoice view, or call it via
205+
Surface it as a button on the Invoice view, or call it via
206206
REST:
207207

208208
```bash
@@ -276,7 +276,7 @@ auditable in the flow builder.
276276

277277
## Visual builder
278278

279-
Console ships a visual flow builder that round-trips with the
279+
ObjectOS ships a visual flow builder that round-trips with the
280280
declarative metadata — non-engineers can edit a flow, and it serializes
281281
back to the same shape as the TypeScript you'd hand-author.
282282

‎content/docs/build/data/index.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Objects, fields, relationships, validation, indexes — described t
44
---
55

66
The data model is the single source of truth for your app. Once an
7-
object exists, ObjectOS gives you REST APIs, a Console view, RBAC
7+
object exists, ObjectOS gives you REST APIs, a generated view, RBAC
88
checkpoints, audit log entries, and AI tool exposure — for free.
99

1010
**Most customers never write the schema by hand.** They describe what
@@ -18,7 +18,7 @@ is generating and can edit it directly when you want to.
1818
| Path | Looks like |
1919
|---|---|
2020
| **AI Builder** (primary) | *"Create a `support_ticket` object with subject, description, priority, status, assignee."* |
21-
| **Console click-build** | Console → Objects → New Object → forms |
21+
| **Click-build** | **Objects → New Object** → forms |
2222
| **TypeScript (`*.object.ts`)** | The TS shown below — typically inside a forked [template](/docs/build/templates) |
2323

2424
All three produce the same schema. The schema is canonical; everything
@@ -74,7 +74,7 @@ export default defineStack({
7474
```
7575

7676
That's all you need. `os dev` recompiles, and `/api/v1/data/todo_task`,
77-
the Console Task view, and the Console permission row all appear.
77+
the generated Task view, and its permission row all appear.
7878

7979
## Field types
8080

@@ -167,7 +167,7 @@ ObjectSchema.create({
167167
});
168168
```
169169

170-
Validation runs on every write — REST, Console, ObjectQL — so there's
170+
Validation runs on every write — REST, the UI, ObjectQL — so there's
171171
no "back door."
172172

173173
## Indexes & performance
@@ -187,7 +187,7 @@ The driver creates real DB indexes on schema sync.
187187

188188
## Field groups
189189

190-
For long forms, group fields in Console:
190+
For long forms, group fields:
191191

192192
```ts
193193
ObjectSchema.create({

‎content/docs/build/data/relationships.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Connect objects with lookups and master-detail — cascade rules, f
55

66
**A relationship is just a field.** Point a `lookup` or `masterDetail`
77
field at another object and ObjectOS wires up everything on top:
8-
foreign-key integrity, the record picker in Console, related lists on
8+
foreign-key integrity, the record picker, related lists on
99
the parent page, and `expand` in queries.
1010

1111
| Type | Cardinality | Delete default | Use for |
@@ -118,7 +118,7 @@ that loops back on itself is not automatically rejected.
118118

119119
> **Tip:** Pair a `tree` / self-lookup field with a
120120
> [tree list view](/docs/build/interface/views) to render the hierarchy
121-
> as nested rows in Console.
121+
> as nested rows.
122122
123123
## Related lists
124124

‎content/docs/build/data/validation-rules.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Validation Rules
33
description: Required fields, unique constraints, and CEL-powered rules that stop bad data at the platform level — with error messages you control.
44
---
55

6-
**Validation runs on every write path.** REST, Console forms, ObjectQL
6+
**Validation runs on every write path.** REST, forms, ObjectQL
77
— the same rules fire everywhere, so there is no back door for bad
88
data. Since 16.0 that includes multi-row updates: a bulk update
99
evaluates the rules once per matched row. A validation rule is a deterministic, synchronous, side-effect-free
@@ -193,7 +193,7 @@ lifecycle hook, and delete-time guards in a `beforeDelete` hook.
193193
## Custom error messages
194194

195195
The `message` is what the user sees when the rule fires — in the
196-
Console form and in the API error response. Make it actionable:
196+
form and in the API error response. Make it actionable:
197197

198198
| Weak | Strong |
199199
|---|---|

‎content/docs/build/index.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Build
3-
description: How apps come to life in ObjectOS — by chatting with AI, by clicking in Console, or by forking a template.
3+
description: How apps come to life in ObjectOS — by chatting with AI, by clicking through forms, or by forking a template.
44
---
55

66
In ObjectOS the customer doesn't write metadata. **They describe what
@@ -10,7 +10,7 @@ most people actually use the platform:
1010
| Path | Who's it for | Output |
1111
|---|---|---|
1212
| **[AI Builder](/docs/build/ai-builder)** (primary) | Business users, product owners, anyone | Live metadata in your tenant, queued for approval |
13-
| **Console click-build** (fallback) | Admins who prefer forms | The same live metadata |
13+
| **Click-build** (fallback) | Admins who prefer forms | The same live metadata |
1414
| **[Template fork](/docs/build/templates)** (dev path) | Engineers who want code under source control | A TypeScript package shipped via the marketplace |
1515

1616
All three paths produce **the same artifact shape** — packages of
@@ -26,14 +26,14 @@ Every app is composed from the same primitives. Learn these once.
2626
| **[Package](/docs/build/packages)** | The unit of organization — `com.acme.crm`, versioned, installable | Packages |
2727
| **[Data model](/docs/build/data)** | Objects + fields + relationships + state machines | Data Model |
2828
| **[Interface](/docs/build/interface)** | Apps, views, forms, dashboards, and pages — what your users see | Interface |
29-
| **[Actions](/docs/build/interface/actions)** | Named operations callable from REST, Console buttons, flows, or AI agents | Actions |
29+
| **[Actions](/docs/build/interface/actions)** | Named operations callable from REST, buttons, flows, or AI agents | Actions |
3030
| **[Flows](/docs/build/automation/flows)** | Declarative business logic (autolaunched / scheduled / manual) | Flows |
3131
| **[Agents](/docs/build/agents)** | End-user AI assistants — Agent → Skill → Tool | Agents |
3232
| **[Marketplace](/docs/build/marketplace)** | Ready-made packages anyone can install in one click | Marketplace |
3333

3434
## Where to start
3535

36-
1. **Just exploring?** → Open Console, start the [AI Builder](/docs/build/ai-builder),
36+
1. **Just exploring?** → Open ObjectOS, start the [AI Builder](/docs/build/ai-builder),
3737
say *"I need to track customer support tickets with priority, status, and assignee."*
3838
You'll have a working object in under 30 seconds.
3939

@@ -49,12 +49,12 @@ Every app is composed from the same primitives. Learn these once.
4949
## What you'll never have to do
5050

5151
- Write a REST endpoint. The platform generates one per object.
52-
- Wire a Console form. The form renders from the schema.
52+
- Wire a form. The form renders from the schema.
5353
- Write RBAC checks. Permissions are declared, not coded.
54-
- Build an admin UI. Console + Account cover both system and business admin.
54+
- Build an admin UI. Setup and Account cover system administration and sign-in.
5555
- Generate types. `@objectstack/spec` derives them from the schema.
5656

5757
ObjectOS is opinionated about this on purpose: **once metadata
58-
exists, every surface (REST, Console, ObjectQL, audit, AI tools)
58+
exists, every surface (REST, the UI, ObjectQL, audit, AI tools)
5959
appears for free.** That's why the AI Builder works — it only needs
6060
to produce metadata, and the platform handles the rest.

‎content/docs/build/interface/actions.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Actions
3-
description: Named operations the platform exposes as REST endpoints, Console buttons, flow steps, and AI tools — from one declaration.
3+
description: Named operations the platform exposes as REST endpoints, buttons, flow steps, and AI tools — from one declaration.
44
---
55

66
An **Action** is a named operation on an object. Declare it once and
77
it appears as:
88

99
- a **REST endpoint** at `/api/v1/actions/<object>/<action>`
10-
- a **button** in Console's record detail
10+
- a **button** on the record detail page
1111
- a **flow step** (`type: 'action'`) for automation
1212
- an **AI tool** (`action_<name>`) for Agents and the AI Builder
1313

@@ -58,7 +58,7 @@ export const approveInvoice = Action.create({
5858
After `os dev` recompiles:
5959

6060
- `POST /api/v1/actions/invoice/approve_invoice` works
61-
- The Invoice record page in Console shows an **Approve Invoice** button
61+
- The Invoice record page shows an **Approve Invoice** button
6262
- A flow can include `{ type: 'action', action: 'approve_invoice', inputs: { note: '…' } }`
6363
- The AI assistant can call `action_approve_invoice` if its skills allow
6464

@@ -109,9 +109,9 @@ either as a trailing path segment (`.../approve_invoice/:recordId`) or in
109109
the body. The response is your script body's return value (or the call
110110
result for `api`-type actions).
111111

112-
### Console
112+
### From the UI
113113

114-
By default, Console shows actions as buttons on the record detail page,
114+
By default, actions appear as buttons on the record detail page,
115115
filtered by the action's `visible` predicate. Override placement
116116
in your view config:
117117

@@ -152,7 +152,7 @@ Actions run with the calling user's permissions. The platform checks:
152152
must have write access (FLS).
153153
3. **UI gating** — the `visible` and `disabled` predicates (CEL,
154154
evaluated against `record`, `os.user`, and params) control whether the
155-
button renders or is greyed out in Console.
155+
button renders or is greyed out.
156156

157157
Failed permission checks return `403` with a `PERMISSION_DENIED` error.
158158

@@ -192,7 +192,7 @@ This is your first stop for *"who pushed the button?"* questions.
192192
193193
The [AI Builder](/docs/build/ai-builder) generates the action metadata and
194194
queues the change for approval. After approval, the action is callable from
195-
REST, Console, flows, and — recursively — the AI itself.
195+
REST, the UI, flows, and — recursively — the AI itself.
196196

197197
## Where to go next
198198

0 commit comments

Comments
 (0)