Skip to content

Commit 51371d3

Browse files
claudeclaude
committed
docs: add Use section — end-user guide verified against the live Console
New top-level Use section for everyday users: console tour, working with records, views, dashboards, approvals, notifications, and profile/settings. Content was verified by driving the showcase app's Console in a browser. Landing page gains a three-audience directory (use / build / administer) and the sidebar orders sections by role. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0145MY7RdJr8KuRMyn5oKAR6
1 parent 3c0774a commit 51371d3

16 files changed

Lines changed: 706 additions & 1 deletion

‎content/docs/index.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,17 @@ ObjectOS never phones home. No telemetry. No license server. Air-gapped
6969
networks are a first-class deployment target — see
7070
[Air-gapped](/docs/deploy/air-gapped).
7171

72+
## Find your docs
73+
74+
This documentation serves three audiences — start at the section that
75+
matches how you use ObjectOS:
76+
77+
| You are … | You want to … | Start here |
78+
|---|---|---|
79+
| **An everyday user** | Work in the apps: records, views, dashboards, approvals | [Use](/docs/use) |
80+
| **A builder** | Create apps: data models, interfaces, automation, AI agents | [Build](/docs/build) |
81+
| **An administrator** | Run the platform: users, permissions, settings, deployment | [Administration](/docs/configure), [Deploy](/docs/deploy), [Operate](/docs/operate/production) |
82+
7283
## Where to go next
7384

7485
| If you want to … | Read |

‎content/docs/meta.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66
"extend-existing-systems",
77
"quickstart",
88
"architecture",
9-
"deploy",
9+
"use",
1010
"build",
1111
"configure",
12+
"deploy",
1213
"operate",
1314
"resources",
1415
"reference"

‎content/docs/use/approvals.mdx‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
title: Approvals
3+
description: Submit records for sign-off, act on requests assigned to you, and always know where every approval stands.
4+
---
5+
6+
# Approvals
7+
8+
Some records need a sign-off before they move forward — an expense over a
9+
limit, a discount, a leave request. When that happens, ObjectOS creates an
10+
**approval request**: a live, system-managed record that tracks that one
11+
submission from the moment it's sent until someone approves or rejects it.
12+
You never create or edit these tracking records yourself — the system keeps
13+
them up to date as decisions are made.
14+
15+
This page covers both sides of the process: submitting something for
16+
approval, and acting on requests that are waiting on you.
17+
18+
## Your approval inbox
19+
20+
Everything approval-related lives in one place: **Account → Inbox →
21+
Approvals**. Open the **Account** app (it's available to everyone), expand
22+
**Inbox** in the left sidebar, and pick **Approvals**.
23+
24+
The list has view tabs across the top, so you can slice the same inbox four
25+
ways:
26+
27+
| View tab | What it shows |
28+
|---|---|
29+
| **My Pending** | Requests waiting on *you* to decide. This is your to-do list. |
30+
| **I Submitted** | Requests you sent for approval — check here to see where your own submissions stand. |
31+
| **Completed** | Requests that have been decided, approved or rejected. |
32+
| **All** | Every approval request you're allowed to see. |
33+
34+
When there's nothing waiting on you, **My Pending** shows the empty state
35+
*"No pending approvals — You're all caught up."* That's the screen you want
36+
to see at the end of the day.
37+
38+
> **Tip:** Bookmark the Approvals inbox, or just glance at the **Needs your
39+
> attention** list on the console home — pending approvals appear there too,
40+
> with how long they've been waiting.
41+
42+
## What an approval request is
43+
44+
| It is… | It is not… |
45+
|---|---|
46+
| A live instance tracked per submission — one request per record sent for approval | A copy of the record itself |
47+
| System-managed — created, updated, and closed automatically as decisions happen | Something you edit by hand |
48+
| Your audit trail — who submitted, who's assigned, what was decided, and when | A one-time notification that disappears |
49+
50+
Because each submission gets its own request, resubmitting a record after a
51+
rejection starts a fresh request — the old one stays in **Completed** as
52+
history.
53+
54+
## Acting on a request
55+
56+
When a request is routed to you, two things happen:
57+
58+
1. **You get a notification** — the bell in the top bar shows an unread
59+
badge, and the item appears in **Needs your attention** on the console
60+
home and in **Account → Inbox → Notifications**.
61+
2. **The record shows approval actions for you** — open the record in
62+
question and you'll see **Approve** and **Reject** as record actions.
63+
These buttons appear only for the assigned approver; other people viewing
64+
the record won't see them.
65+
66+
| To… | Do this |
67+
|---|---|
68+
| See what's waiting on you | **Account → Inbox → Approvals** → **My Pending**, or the bell / **Needs your attention** |
69+
| Review the details | Open the record from the request — read the highlights and field sections like any other record |
70+
| Decide | Use the **Approve** or **Reject** record action |
71+
| Confirm it went through | The request moves to **Completed**, and the submitter is notified |
72+
73+
> **Tip:** Read the record, not just the request. The approval request tells
74+
> you *that* something needs a decision; the record itself tells you
75+
> *whether* to approve it.
76+
77+
## Records locked while pending
78+
79+
Depending on how the approval is configured, a record may be **locked**
80+
while its request is pending — fields can't be edited until a decision is
81+
made. This protects the approver: what they approve is exactly what was
82+
submitted, with no quiet edits in between. If you need to change a locked
83+
record, ask the approver to reject it (or withdraw it, where your app
84+
allows), make your changes, and resubmit.
85+
86+
## App-provided review queues
87+
88+
Some apps add their own curated **review-queue page** — for example an
89+
"Approvals" page in the app's navigation that shows just the items relevant
90+
to that team, pre-filtered and ready to work through. Use it when it's
91+
there; it's the same underlying requests, just a friendlier lens. Your
92+
**Account → Inbox → Approvals** inbox always remains the complete,
93+
everything-in-one-place view.
94+
95+
## Where to go next
96+
97+
| What now | Read |
98+
|---|---|
99+
| Tour the console as an everyday user | [Using ObjectOS](/docs/use) |
100+
| Work with the records you're approving | [Records](/docs/use/records) |
101+
| Keep up with everything else routed to you | [Notifications](/docs/use/notifications) |
102+
| Slice lists the way approvers do | [Views](/docs/use/views) |

‎content/docs/use/dashboards.mdx‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: Dashboards
3+
description: Read your team's KPIs, charts, and tables at a glance — and narrow them by date or filter in two clicks.
4+
---
5+
6+
# Dashboards
7+
8+
A **dashboard** turns your records into numbers and charts: how many
9+
tasks are open, how work is trending, who's carrying the load. You
10+
don't build dashboards here — you read them; they update themselves
11+
as records change.
12+
13+
## Where dashboards live
14+
15+
Dashboards are items in an app's **navigation sidebar**, usually
16+
inside a group such as **Analytics**. Click one and it opens like any
17+
other page.
18+
19+
## The dashboard header
20+
21+
At the top of every dashboard:
22+
23+
| Element | What it does |
24+
|---|---|
25+
| **Title and description** | What this dashboard measures and why |
26+
| **Date-range preset** | A dropdown like **Last 90 days** — changes the time window for every widget at once |
27+
| **Dashboard filters** | Dropdowns like **Task Status: All** — narrow all widgets to a slice (e.g. only *In Progress*) |
28+
29+
> **Tip:** If a number looks wrong, check the date range and filters
30+
> first — "Last 90 days" with **Task Status: Done** shows a very
31+
> different picture than all-time, all statuses.
32+
33+
Date range and filters apply to the **whole dashboard**, so every
34+
widget answers the same question about the same slice of data — you
35+
never have to wonder whether two charts are counting different things.
36+
37+
## Widget types
38+
39+
A dashboard is a grid of **widgets**. You'll meet three kinds:
40+
41+
| Widget | Looks like | Good for |
42+
|---|---|---|
43+
| **KPI stat tile** | One big number with a label | Headline figures — *Open Tasks: 42* |
44+
| **Chart** | Bar, pie, and similar visuals | Comparing groups and spotting trends |
45+
| **Table** | Rows and columns | The detail behind a number — top items, recent records |
46+
47+
A typical layout puts a row of stat tiles at the top (the headlines),
48+
charts in the middle (the shape of the data), and tables at the bottom
49+
(the receipts). Read it in that order and you'll have the story in
50+
under a minute.
51+
52+
## Dashboards vs. views
53+
54+
Both show your records — from different altitudes:
55+
56+
| Surface | Shows | Use it when |
57+
|---|---|---|
58+
| **Dashboard** | Aggregates — counts, totals, trends | You want the big picture |
59+
| **View** | Individual records, row by row | You want to work the list — see [Using views](/docs/use/views) |
60+
61+
## Empty states
62+
63+
A widget with nothing to show says so plainly — for example a table
64+
displaying **No rows**. That's not an error: with the current date
65+
range and filters, no records match. Widen the range or reset a
66+
filter and the data usually reappears.
67+
68+
## From number to records
69+
70+
Dashboards summarize records, and some widgets let you **drill
71+
through** to them: where a tile, chart segment, or table row is
72+
clickable, it opens the matching records so you can act on what the
73+
number is telling you. From there you're in a normal list — see
74+
[Using views](/docs/use/views).
75+
76+
> **Tip:** Reading a dashboard is a loop: spot the odd number, narrow
77+
> with a filter, drill through to the records, fix what needs fixing.
78+
79+
## Where to go next
80+
81+
| I want to… | Read |
82+
|---|---|
83+
| Work with the records behind the numbers | [Working with records](/docs/use/records) |
84+
| Filter and group a list myself | [Using views](/docs/use/views) |
85+
| Handle requests waiting on me | [Approvals](/docs/use/approvals) |
86+
| Manage what notifications I get | [Notifications](/docs/use/notifications) |
87+
| Back to the Console tour | [Using ObjectOS](/docs/use) |

‎content/docs/use/index.mdx‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: Using ObjectOS
3+
description: Sign in once and find every app, record, and notification your team shares — a five-minute tour of the Console.
4+
---
5+
6+
# Using ObjectOS
7+
8+
ObjectOS is where your team's business apps live — projects, tasks,
9+
approvals, dashboards. You sign in once and see every app you have
10+
access to, in one place, with one search box.
11+
12+
This section is for **everyday users**. If you build apps or
13+
administer the system, head to [Build](/docs/build) or
14+
[Configure](/docs/configure) instead.
15+
16+
## Signing in
17+
18+
Open the URL your team gave you and sign in with your **email and
19+
password**. Your session is remembered, so you stay signed in on that
20+
browser until you log out from the avatar menu.
21+
22+
## The Console home
23+
24+
After signing in you land on the home page. Top to bottom:
25+
26+
| Area | What it shows |
27+
|---|---|
28+
| **Greeting** | A personal hello ("Good afternoon, Ada") |
29+
| **Your apps** | A grid of tiles — one per app you have access to. Click a tile to open the app. |
30+
| **Needs your attention** | Pending notifications and approvals, with how long ago each arrived |
31+
| **Recently Accessed** | Objects and records you opened recently — the fastest way back to yesterday's work |
32+
| **Activity feed** | Recent activity across your workspace |
33+
34+
> **Tip:** Treat **Needs your attention** as your morning inbox — it
35+
> surfaces approvals waiting on you before you open any app.
36+
37+
## Switching between apps
38+
39+
The **breadcrumb** in the top-left corner always tells you where you
40+
are: *app → object → record*. The first segment is an **app
41+
switcher** — click it to drop down a list of your apps and jump
42+
between them without going back home.
43+
44+
Every install has, alongside the business apps built for your team:
45+
46+
| App | Who sees it | What it's for |
47+
|---|---|---|
48+
| **Account** | Everyone | Your personal space — profile, notifications inbox, approvals, security |
49+
| **Setup** | Admins only | System administration |
50+
51+
## The app navigation sidebar
52+
53+
Inside an app, the left sidebar is that app's menu. It contains flat
54+
items and **collapsible groups** (for example *Workspace* or
55+
*Analytics*). Each item opens one of three things:
56+
57+
| Item type | What clicking it opens |
58+
|---|---|
59+
| An object (e.g. *Tasks*) | Its list views — see [Views](/docs/use/views) |
60+
| A page | A custom page built for your app |
61+
| A dashboard | Charts and KPIs — see [Dashboards](/docs/use/dashboards) |
62+
63+
A **pin icon** appears next to the active item so you can pin the
64+
places you use most.
65+
66+
## Global search
67+
68+
Press `⌘K` (Mac) or `Ctrl-K` (Windows/Linux), or click **Search…** in
69+
the top bar. A dialog opens that searches **records across all your
70+
objects** — type a few letters of a task name, project, or customer
71+
and jump straight to it.
72+
73+
## The top bar
74+
75+
The top bar is visible on every screen:
76+
77+
| Control | What it does |
78+
|---|---|
79+
| **Search…** | Opens global search (`⌘K` / `Ctrl-K`) |
80+
| **Bell** | Notifications, with a red badge showing your unread count. The full inbox lives in **Account → Inbox → Notifications**. |
81+
| **?** | Help |
82+
| **Avatar** | Your account menu (below) |
83+
84+
The **avatar menu** shows your name and email, and contains:
85+
86+
| Entry | What it does |
87+
|---|---|
88+
| **Profile** | Opens your profile in the Account app |
89+
| **Preferences → Theme** | Switch between light and dark |
90+
| **Preferences → Language** | Change the interface language |
91+
| **Log out** | End your session |
92+
93+
> **Tip:** Theme and language live in the **avatar menu → Preferences**,
94+
> not on your Profile page — a common place to look first.
95+
96+
## Where to go next
97+
98+
| I want to… | Read |
99+
|---|---|
100+
| Open, create, and edit records | [Working with records](/docs/use/records) |
101+
| Switch between grid, kanban, calendar and more | [Using views](/docs/use/views) |
102+
| Read charts and KPIs | [Dashboards](/docs/use/dashboards) |
103+
| Approve or reject requests | [Approvals](/docs/use/approvals) |
104+
| Manage my notifications | [Notifications](/docs/use/notifications) |
105+
| Update my name, photo, or password | [Profile & security](/docs/use/profile) |
106+
| Build or customize apps | [Build](/docs/build) |
107+
| Administer the system | [Configure](/docs/configure) |

‎content/docs/use/meta.de.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"title": "Verwenden",
3+
"pages": ["index", "records", "views", "dashboards", "approvals", "notifications", "profile"]
4+
}

‎content/docs/use/meta.es.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"title": "Usar",
3+
"pages": ["index", "records", "views", "dashboards", "approvals", "notifications", "profile"]
4+
}

‎content/docs/use/meta.fr.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"title": "Utiliser",
3+
"pages": ["index", "records", "views", "dashboards", "approvals", "notifications", "profile"]
4+
}

‎content/docs/use/meta.ja.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"title": "使い方",
3+
"pages": ["index", "records", "views", "dashboards", "approvals", "notifications", "profile"]
4+
}

‎content/docs/use/meta.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"title": "Use",
3+
"pages": ["index", "records", "views", "dashboards", "approvals", "notifications", "profile"]
4+
}

0 commit comments

Comments
 (0)