Skip to content

Commit cb41537

Browse files
docs: define Studio in the glossary, make the Setup/Studio split canonical (#151)
Executes the 2026-08-20 maintainer ruling on #102 (option 1: Studio survives as the named metadata-authoring surface). - resources/glossary.mdx gains a `Studio` entry in alphabetical position that DEFINES the surface -- route, gate, what is authored there, and its relation to Setup -- rather than describing it. Describing without deciding is how this corpus grew two mutually-referential `Console` entries (#89), which the card forbids explicitly. - configure/index.mdx promotes "Permissions are designed in Studio, assigned in Setup" from a page callout to `## Setup and Studio`: the canonical statement of the split, with both names' routes, capabilities and audiences side by side. - The four PR #100 rewrites that dropped the noun now name Studio as the destination: build/data/index.mdx, build/packages.mdx, build/agents.mdx, configure/permissions/index.mdx. Every product fact asserted here was measured on the sibling repos' origin/main (objectstack 2866d5f97e, objectui 6ff0eb1), not composed: the route (`/studio/:packageId/:tab` inside the `/_console/` SPA), the entry gate (`studio.access`, STUDIO_ENTRY_CAPABILITY), the four pillars (Data, Automations, Interfaces, Access) and the five metadata kinds Studio creates (package, app, object, flow, permission). English only; locale siblings left alone and report stale, per AGENTS.md. Claude-Session: https://claude.ai/code/session_01V8AcCw8C1feB7b5kiaJd7b Co-authored-by: Claude <noreply@anthropic.com>
1 parent 614cfd7 commit cb41537

6 files changed

Lines changed: 37 additions & 9 deletions

File tree

‎content/docs/build/agents.mdx‎

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

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

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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-
| **Click-build** | **Objects → New Object** → forms |
21+
| **Click-build** | **Studio → 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

‎content/docs/build/packages.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ pnpm dev
5151

5252
### From the UI
5353

54-
**Packages → New Package** — name, id, version, namespace.
54+
**Studio → Packages → New Package** — name, id, version, namespace.
5555

5656
## Active package
5757

‎content/docs/configure/index.mdx‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,24 @@ You manage people and their permissions day to day; the applications,
1010
objects, and permission sets themselves ship with the platform and the
1111
app packages you install.
1212

13-
> **Permissions are designed in Studio, assigned in Setup.** Most
14-
> administration never leaves Setup — you enter Studio only to author
15-
> permission sets or to run the explain engine.
13+
## Setup and Studio
14+
15+
**Permissions are designed in Studio, assigned in Setup.** That
16+
sentence is the canonical statement of a split that runs through the
17+
whole product, not a rule about permissions alone: Setup *operates* a
18+
running deployment, Studio *authors* the metadata that deployment runs.
19+
Both live inside the same UI at `/_console/`; neither is a surface of
20+
its own.
21+
22+
| | Setup | Studio |
23+
|---|---|---|
24+
| Answers | Who is here, and what may they do? | What does this app consist of? |
25+
| Where | `/_console/apps/setup` | `/_console/studio` |
26+
| Gated by | `setup.access` | `studio.access` |
27+
| For | System administrators | Implementers and developers |
28+
29+
Most administration never leaves Setup — you enter Studio only to
30+
author permission sets or to run the explain engine.
1631

1732
## The Setup app
1833

‎content/docs/configure/permissions/index.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,9 +161,9 @@ applies uniformly across REST, ObjectQL, and the UI.
161161
- The **explain engine** (`explain(principal, object, operation)`)
162162
reports the verdict of every layer in order — required permissions,
163163
object CRUD, field security, OWD baseline, sharing, row-level
164-
security — with per-layer attribution. It surfaces as the
165-
"Why can this user access?" panel. Explaining another user requires
166-
the `manage_users` capability.
164+
security — with per-layer attribution. Studio's **Access** pillar
165+
surfaces it as the "Why can this user access?" panel. Explaining
166+
another user requires the `manage_users` capability.
167167
- `/_console/` shows the effective permissions of any user as they're
168168
evaluated.
169169
- Audit log (`sys_audit_log`) records permission-sensitive changes —

‎content/docs/resources/glossary.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,19 @@ query time, compiled into row-level filters. A rule stored **without**
199199
criteria shares nothing — it is not a match-all. See
200200
[Record Access](/docs/configure/permissions/record-access#both-switches-fail-closed).
201201

202+
### Studio
203+
204+
The built-in metadata-authoring surface, at `/studio` inside the UI
205+
served at `/_console/`, gated by the `studio.access` permission.
206+
Where the metadata itself is *designed* — packages, objects, apps,
207+
flows and permission sets — one package at a time, across four pillars:
208+
Data, Automations, Interfaces, Access. Peer of **Setup**, not part of
209+
it: Setup operates a running deployment (its people, their grants, its
210+
configuration), Studio authors what that deployment runs — hence
211+
**permissions are designed in Studio, assigned in Setup**. Unlike
212+
Setup it is not an app under `/apps/`; the UI serves it as its own
213+
route subtree. See [Administration](/docs/configure#setup-and-studio).
214+
202215
### Surface
203216

204217
One of the HTTP entry points a running ObjectOS exposes: `/` (REST API)

0 commit comments

Comments
 (0)