Skip to content

Commit 873c099

Browse files
os-zhuangclaude
andcommitted
docs(ia): audience-first navigation — Learn/Build/Operate/Extend sections + business-facing entry pages
- Root sidebar split into four audience sections via separators (zero URL churn) - getting-started split into Start Here / Cheatsheets; CLI and Validating Metadata moved to Deployment & Operations with redirects (incl. chain fix for the pre-2026-07 guides redirect) and in-content link rewrites - New: getting-started/platform-capabilities (business-language capability tour, HotCRM as running example) and getting-started/build-without-code (Studio/Console/Setup visual-building guide) - concepts/index gains Find Your Path reader cards; ui section renamed 'Views & Apps' in nav and home cards Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 0c354dd commit 873c099

22 files changed

Lines changed: 165 additions & 26 deletions
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
---
3+
4+
docs: audience-first IA — sidebar sections (Learn / Build / Operate / Extend & Reference), tooling pages moved to Deployment with redirects, new business-facing capability tour and no-code building guide, reader-path cards on Core Concepts.

apps/docs/redirects.mjs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ export const docsRedirects = [
1212
// getting-started
1313
['/docs/guides/cheatsheets/quick-reference', '/docs/getting-started/quick-reference'],
1414
['/docs/guides/common-patterns', '/docs/getting-started/common-patterns'],
15-
['/docs/guides/validating-metadata', '/docs/getting-started/validating-metadata'],
15+
['/docs/guides/validating-metadata', '/docs/deployment/validating-metadata'],
16+
// 2026-07 audience-first IA: tooling pages moved out of getting-started
17+
['/docs/getting-started/cli', '/docs/deployment/cli'],
18+
['/docs/getting-started/validating-metadata', '/docs/deployment/validating-metadata'],
1619
// concepts
1720
['/docs/getting-started/core-concepts', '/docs/concepts'],
1821
['/docs/getting-started/architecture', '/docs/concepts/architecture'],

content/docs/concepts/index.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,17 @@ import { Scale, Code2, Database, ScrollText, Laptop } from 'lucide-react';
99

1010
Before diving into code, understanding these foundational ideas will make everything else click.
1111

12+
## Find Your Path
13+
14+
Different readers need different doors into this documentation — pick yours:
15+
16+
<Cards>
17+
<Card href="/docs/getting-started/platform-capabilities" title="I'm evaluating the platform" description="A business-language tour of what the platform can do — views, automation, approvals, permissions, analytics — no code required to read" />
18+
<Card href="/docs/getting-started/build-without-code" title="I build with the visual tools" description="What admins and business analysts can do in Studio, Console, and Setup without writing metadata by hand" />
19+
<Card href="/docs/getting-started/your-first-project" title="I write metadata" description="The developer path: scaffold a project, author typed metadata with an AI agent, validate, and ship" />
20+
<Card href="/docs/kernel" title="I extend the platform" description="The contributor path: kernel architecture, plugins, services, and the protocol spec" />
21+
</Cards>
22+
1223
## Metadata-Driven Development
1324

1425
Metadata-driven development is a paradigm shift where **application logic is defined by declarative data (metadata), not imperative code.**
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ os validate path/to/config # Validate specific file
440440
`os validate` will not fail the build on schema/predicate/binding grounds. In a
441441
scaffolded project these are wired as `npm run validate` and `npm run build`;
442442
your `AGENTS.md` tells coding agents to run `npm run validate` after editing
443-
metadata. See [Validating metadata](/docs/getting-started/validating-metadata).
443+
metadata. See [Validating metadata](/docs/deployment/validating-metadata).
444444
</Callout>
445445

446446
#### `os info`

content/docs/deployment/meta.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
"icon": "Cloud",
44
"pages": [
55
"index",
6+
"cli",
7+
"validating-metadata",
68
"self-hosting",
79
"backup-restore",
810
"vercel",

content/docs/deployment/self-hosting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ objectstack.config.ts ──(os build, CI)──▶ dist/objectstack.json ──
2121
JSON file — your entire app. Build it once in CI; the host needs no
2222
TypeScript and no build step.
2323
- **`os start`** boots a production server directly from that artifact
24-
([reference](/docs/getting-started/cli#os-start)).
24+
([reference](/docs/deployment/cli#os-start)).
2525
- **Deployment config stays outside the artifact.** Database URL, secrets, and
2626
environment identity are injected via `OS_*` environment variables or flags.
2727

@@ -346,7 +346,7 @@ Disable with `OS_MCP_SERVER_ENABLED=false`. See
346346

347347
- [Backup & Restore](/docs/deployment/backup-restore) — what to back up, and the restore drill
348348
- [Deployment Modes](/docs/deployment) — the map of local / standalone / Cloud
349-
- [`os start` reference](/docs/getting-started/cli#os-start) — every flag and env var
349+
- [`os start` reference](/docs/deployment/cli#os-start) — every flag and env var
350350
- [Environment Variables](/docs/deployment/environment-variables) — the full catalog
351351
- [Deploy to Vercel](/docs/deployment/vercel) — the serverless alternative
352352
- [Troubleshooting & FAQ](/docs/deployment/troubleshooting)

content/docs/deployment/single-project-mode.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,4 +108,4 @@ environments, provision databases, or mount a control plane.
108108

109109
- [Environment-Scoped Routing](/docs/api/environment-routing)
110110
- [Deployment Modes](/docs/deployment)
111-
- [CLI reference](/docs/getting-started/cli)
111+
- [CLI reference](/docs/deployment/cli)

content/docs/getting-started/validating-metadata.mdx renamed to content/docs/deployment/validating-metadata.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,6 @@ Both commands support `--json` and exit non-zero on failure:
173173
174174
## See also
175175
176-
- [Command Line Interface](/docs/getting-started/cli) — full `os validate` / `os build` reference
176+
- [Command Line Interface](/docs/deployment/cli) — full `os validate` / `os build` reference
177177
- [Formula & Predicates](/docs/data-modeling/formulas) — the CEL surface and `record.` scope
178178
- [Data Modeling](/docs/data-modeling) — objects, fields, validations, sharing

content/docs/getting-started/build-with-claude-code.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ discovering a dead button three screens deep in the browser. This is the
247247
["contract-first" guarantee](/docs/getting-started/how-ai-development-works#why-its-safe):
248248
the error is rejected at the authoring gate, not tolerated by a lenient runtime.
249249
For the full list of what the gate checks, see
250-
[Validating Metadata](/docs/getting-started/validating-metadata).
250+
[Validating Metadata](/docs/deployment/validating-metadata).
251251

252252
Once it's clean:
253253

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Build Without Code
3+
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
4+
---
5+
6+
# Build Without Code
7+
8+
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.
9+
10+
## Console — where the app runs
11+
12+
`/_console/` is the workspace end users live in:
13+
14+
- **Home** lists your apps, pending approvals, scheduled digests, and recently visited records.
15+
- Each app renders its declared navigation, views (table, kanban, calendar, gantt, …), dashboards, and record pages — switch views from the toolbar, save filters, pin favorites.
16+
- **Approvals inbox** collects everything waiting on you; decisions (approve / reject / send back) happen here.
17+
- Record pages carry the collaboration surface: discussion threads, attachments, activity timeline, and change history.
18+
- Global search (`⌘K`) spans objects, with partial and pinyin matching.
19+
20+
## Studio — where the app is designed
21+
22+
From any app, **"Design in Studio"** opens the same application in design mode. Studio is organized around four pillars:
23+
24+
| Pillar | What you manage there |
25+
|---|---|
26+
| **Data** | Every object with its fields, plus per-object tabs for records, forms, validation rules, lifecycle hooks, actions, and API exposure |
27+
| **Automation** | All flows in one list with enable/disable switches; each opens as a visual diagram — triggers, branches, approval nodes, run history, and problem markers |
28+
| **Interface** | Apps, navigation, views, pages, and dashboards |
29+
| **Access** | Permission sets as a matrix of object/field grants, plus sharing configuration |
30+
31+
Two properties make Studio safe to hand to non-developers:
32+
33+
- **Draft → publish.** Changes save as drafts and go live only when published, with a change list to review first.
34+
- **Same gate as code.** A change that would break the app (a dangling reference, an invalid predicate) is rejected by the same validation that checks hand-written metadata — there is no "UI edits bypass review" back door.
35+
36+
## Setup — where the platform is administered
37+
38+
The **System Settings** app covers platform administration: user management and invitations, permission assignment, datasources (including federated external databases), diagnostics and audit logs, and the **Marketplace** — template apps such as HotCRM install with one click and appear alongside your own apps, ready to customize in Studio.
39+
40+
## When to reach for code instead
41+
42+
Visual editing shines for day-to-day evolution: adding fields, adjusting views, tweaking a flow, granting access. Teams typically switch to [metadata as code](/docs/getting-started/your-first-project) when they want version control and pull-request review across many changes, AI-assisted authoring, or promotion of the same app across environments. Both roads meet in the same artifact — start visual, graduate to code, or run both side by side.

0 commit comments

Comments
 (0)