Skip to content

Commit c11be8a

Browse files
committed
docs(ui): drop the links and indexes that named the deleted host examples and guide
Co-authored-by: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ADHkmQmtHYkx1Ve9ob2ikN
1 parent ff1721a commit c11be8a

11 files changed

Lines changed: 28 additions & 111 deletions

File tree

‎ui/CONTRIBUTING.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,6 @@ git checkout -b feature/your-feature-name
9999
# including the visual designer, which mounts here rather than in a demo of its own)
100100
pnpm dev
101101

102-
# Run an example app (console-starter and byo-backend-console are the two that ship
103-
# a dev server; hello-world has none, and schema-catalog is a data package)
104-
pnpm --filter @object-ui/example-console-starter dev
105-
106102
# Run the documentation site
107103
pnpm site:dev
108104
```

‎ui/QUICK_REFERENCE.md‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,17 +63,12 @@ vitest 调用被拒绝:从包目录跑 vitest 会静默跑错测试集 (objectui
6363

6464
Details in [AGENTS.md](./AGENTS.md) (“怎么跑测试”) and `scripts/vitest-invocation-guard.mjs`.
6565

66-
### Run Examples
66+
### Examples
6767

68-
```bash
69-
pnpm --filter @object-ui/example-console-starter dev # Fork-ready ObjectStack console
70-
pnpm --filter @object-ui/example-byo-backend-console dev # ObjectUI on your own backend
71-
```
72-
73-
Those are the only two dev servers under `examples/`: `hello-world` is a snippet to paste
68+
No directory under `examples/` is a dev server: `hello-world` is a snippet to paste
7469
into your own app and `schema-catalog` is a data package, so neither declares a `dev`
75-
script. [`examples/README.md`](./examples/README.md) is the index — which one to pick,
76-
what to build first, and the port each one serves on.
70+
script. [`examples/README.md`](./examples/README.md) is the index. The console to run is
71+
`apps/console` (`pnpm dev`).
7772

7873
### Release (via changesets)
7974

‎ui/README.md‎

Lines changed: 4 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,6 @@ Pick the path that matches where you are starting from:
5656
| You want to… | Start here | Install |
5757
|---|---|---|
5858
| Render a JSON schema inside your React app | [`examples/hello-world`](examples/hello-world) | `@object-ui/react @object-ui/components` |
59-
| Embed views in an existing app, against **your own** backend | [`examples/byo-backend-console`](examples/byo-backend-console) | `@object-ui/app-shell @object-ui/plugin-view @object-ui/react` |
60-
| Stand up a complete console on an **ObjectStack** backend | [`examples/console-starter`](examples/console-starter) | fork the example |
6159
| Build a UI from a JSON file, no React code at all | [`@object-ui/cli`](packages/cli) | `npm install -g @object-ui/cli` |
6260

6361
The [examples catalog](examples/README.md) explains each one in more depth.
@@ -115,47 +113,6 @@ it is handed to the component the schema names — so a value passed as `data={
115113
read nor refused, and the expression that wanted it is returned as its own source text, with
116114
nothing thrown and one line on the console.
117115

118-
### Bring your own backend
119-
120-
Use the shell and views without the full console infrastructure — your routing, your auth, your API:
121-
122-
```bash
123-
npm install @object-ui/app-shell @object-ui/plugin-view @object-ui/react
124-
```
125-
126-
```tsx
127-
import type { FC } from 'react';
128-
import { AppShell } from '@object-ui/app-shell';
129-
import { ObjectView } from '@object-ui/plugin-view';
130-
import { ThemeProvider, SchemaRendererProvider } from '@object-ui/react';
131-
import type { DataSource } from '@object-ui/types';
132-
133-
// The two pieces you bring: the backend adapter you implement (see "Custom
134-
// Data Sources" below) and your own sidebar component.
135-
declare const myAPI: DataSource;
136-
declare const MySidebar: FC;
137-
138-
function MyConsole() {
139-
return (
140-
<ThemeProvider>
141-
<SchemaRendererProvider dataSource={myAPI}>
142-
<AppShell sidebar={<MySidebar />}>
143-
<ContactList />
144-
</AppShell>
145-
</SchemaRendererProvider>
146-
</ThemeProvider>
147-
);
148-
}
149-
150-
function ContactList() {
151-
return (
152-
<ObjectView schema={{ type: 'object-view', objectName: 'contact' }} dataSource={myAPI} />
153-
);
154-
}
155-
```
156-
157-
[`examples/byo-backend-console`](examples/byo-backend-console) is the complete working version, with a mock REST adapter.
158-
159116
### No React at all
160117

161118
```bash
@@ -167,18 +124,10 @@ objectui dev app.json # dev server on http://localhost:3000
167124

168125
Edit `app.json` to build your UI.
169126

170-
### Run the examples from this repo
171-
172-
```bash
173-
pnpm run setup # builds @objectstack/* at .objectstack-sha, then installs
174-
pnpm -w build
175-
176-
cd examples/console-starter # or examples/byo-backend-console
177-
pnpm dev
178-
```
127+
### The examples in this repo
179128

180-
`hello-world` ships no dev server: copy its `App.tsx` and `schema.json` into your own
181-
Vite/Next.js app. `schema-catalog` is a data package — the canonical JSON schemas the
129+
Neither example ships a dev server. `hello-world` is a snippet: copy its `App.tsx` and
130+
`schema.json` into your own Vite/Next.js app. `schema-catalog` is a data package — the canonical JSON schemas the
182131
docs render, a smoke test mounts, and AI agents use as a few-shot corpus.
183132

184133
## Copy-Paste Schemas
@@ -378,7 +327,7 @@ Grouped by dependency weight — atoms and fields stay light, heavy widgets live
378327

379328
| Package | Description |
380329
|---------|-------------|
381-
| **[@object-ui/app-shell](./packages/app-shell)** | Minimal application shell — the base of every console |
330+
| **[@object-ui/app-shell](./packages/app-shell)** | The Console's shell, views and Studio; a private workspace package since 18.2, no longer published to npm |
382331
| **[@object-ui/providers](./packages/providers)** | The upload adapter context the file and image fields upload through |
383332
| **[@object-ui/auth](./packages/auth)** | `AuthProvider`, `useAuth`, `AuthGuard`, sign-in forms |
384333
| **[@object-ui/permissions](./packages/permissions)** | Object / field / row-level permission guards and hooks |

‎ui/content/docs/guide/objectos-integration.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,6 @@ test('create contact workflow', async ({ page }) => {
681681
- [ObjectStack Documentation](https://docs.objectstack.ai)
682682
- [ObjectUI Components Reference](/docs/components)
683683
- [ObjectQL Schemas](/docs/api/schema-reference#objectql-schemas)
684-
- [Example: ObjectStack Console Starter](https://github.com/objectstack-ai/objectui/tree/main/examples/console-starter)
685684
- [Schema Catalog](/docs/guide/schema-catalog) - every schema rendered in these docs
686685

687686
## Support

‎ui/examples/README.md‎

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,10 @@ Runnable examples that show how to consume ObjectUI in different scenarios. Pick
77
| Example | Use it when… | Backend | Bundle | What it gives you |
88
|---|---|---|---|---|
99
| [`hello-world/`](./hello-world) | You want the smallest possible `<SchemaRenderer>` demo to see the JSON → React pipeline. | None (in-memory schema) | Tiny | A single `App.tsx` rendering one schema. |
10-
| [`byo-backend-console/`](./byo-backend-console) | You want to **embed** ObjectUI into your own app and connect it to **your own** REST/GraphQL backend. | Bring-your-own (mock REST shown) | ~50 KB | `@object-ui/app-shell` + `@object-ui/react`, custom router, custom `DataSource`. ~100 lines of integration code, no auth, no plugins. |
11-
| [`console-starter/`](./console-starter) | You want a **fork-ready, opinionated console** with the full plugin set already wired against an **ObjectStack** backend. | ObjectStack (`/api/v1`) | Full | `@object-ui/app-shell` `ConsoleShell` + `AuthProvider` + every `@object-ui/plugin-*` (grid, kanban, calendar, charts, dashboard, designer, detail, form, list, report, view, chatbot). |
1210

13-
> **Rule of thumb:**
14-
> - Learning the rendering protocol → `hello-world`.
15-
> - Adding ObjectUI to an existing product / different backend → `byo-backend-console`.
16-
> - Standing up a brand-new ObjectStack console → fork `console-starter`.
11+
> The console itself is `apps/console`, built for ObjectOS. `@object-ui/app-shell`, the
12+
> package its shell and views live in, is private and no longer published to npm, so there
13+
> is no host-console example to fork.
1714
1815
### Also under `examples/`
1916

@@ -23,18 +20,7 @@ Runnable examples that show how to consume ObjectUI in different scenarios. Pick
2320

2421
## Running an example
2522

26-
`byo-backend-console` and `console-starter` are Vite apps. From the monorepo root:
27-
28-
```bash
29-
pnpm install
30-
pnpm -w build
31-
cd examples/console-starter # or byo-backend-console
32-
pnpm dev
33-
```
34-
35-
Each exposes its own dev server port (see its README).
36-
37-
The other two directories are not dev servers: `hello-world` is a snippet to drop into
23+
Neither directory is a dev server: `hello-world` is a snippet to drop into
3824
your own Vite/Next.js app, and `schema-catalog` is a data package verified with
3925
`pnpm --filter @object-ui/example-schema-catalog test`.
4026

@@ -44,4 +30,4 @@ your own Vite/Next.js app, and `schema-catalog` is a data package verified with
4430
2. Mark it `private: true`.
4531
3. Add an entry to the table above and link its README.
4632
4. Reference workspace packages with `workspace:*`.
47-
5. Keep the dependency footprint aligned with the example's purpose — heavy plugins belong in `console-starter`, not in lightweight integration demos.
33+
5. Keep the dependency footprint aligned with the example's purpose — heavy plugins belong in `apps/console`, not in lightweight integration demos.

‎ui/examples/hello-world/README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,4 @@ pnpm install
2828

2929
## Learn more
3030

31-
- [BYO Backend Console](../byo-backend-console/) — add ObjectUI to an existing product with your own REST/GraphQL backend (~100 lines: custom `DataSource` + router)
32-
- [Console Starter](../console-starter/) — fork it to stand up a brand-new ObjectStack console, with the full plugin set already wired
3331
- [Schema Catalog](../schema-catalog/) — canonical JSON schemas used across docs & tests

‎ui/examples/schema-catalog/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Canonical JSON schema catalog for ObjectUI. **Private** (not published to npm).
44

55
> Naming note: this package lives under `examples/` (alongside the runnable
66
> example apps), but it is **not** itself a runnable app — it is a data
7-
> package + smoke tests. The runnable apps are `examples/hello-world`,
8-
> `examples/console-starter`, etc.
7+
> package + smoke tests. Its sibling `examples/hello-world` is a snippet to
8+
> paste into your own app.
99
1010
This package is the **single source of truth** for every schema example we ship.
1111
It is consumed by:

‎ui/packages/app-shell/README.md‎

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# @object-ui/app-shell
22

3-
**Minimal Application Shell for ObjectUI**
3+
**The ObjectOS Console's shell, views and Studio — a private workspace package**
44

5-
A lightweight, framework-agnostic rendering engine that enables third-party systems to integrate ObjectUI components without inheriting the full console infrastructure.
5+
> **Not published since 18.2.** This package exists to serve the ObjectOS Console
6+
> (`apps/console`), and a customisable console for a third-party host has no business
7+
> demand today, so it is `private: true` and no longer released to npm. The last published
8+
> version is 18.1.x, which the maintainer deprecates on npm after 18.2. Inside this
9+
> workspace `apps/console` and the `@object-ui/*` packages keep importing it as before.
610
711
## Purpose
812

@@ -15,9 +19,8 @@ This package provides the essential building blocks for rendering ObjectUI schem
1519

1620
## Installation
1721

18-
```bash
19-
pnpm add @object-ui/app-shell
20-
```
22+
There is nothing to install from npm: the package is private (see above). Workspace
23+
consumers declare it as `"@object-ui/app-shell": "workspace:*"`.
2124

2225
## Requires a bundler — plain Node cannot import this package
2326

@@ -196,7 +199,7 @@ reads as off, so a self-hosted admin's page load issues no request and logs no
196199
## Default auth pages and the sign-up offer
197200

198201
`DefaultLoginPage` and `DefaultRegisterPage` are the sign-in and sign-up pages
199-
a host mounts at `/login` and `/register` (`examples/console-starter` does).
202+
a host mounts at `/login` and `/register` (`apps/console` mounts its own pages there).
200203
They offer a generic sign-up only where the server would accept one. The
201204
server states that rule in two keys of `GET /api/v1/auth/config`:
202205
`emailPassword.disableSignUp` (the hard off switch) and
@@ -1096,15 +1099,6 @@ Third-Party App
10961099
| Data Source | Any | ObjectStack |
10971100
| Customization | Full control | Limited |
10981101

1099-
## Examples
1100-
1101-
See `examples/byo-backend-console` for a complete working example that demonstrates:
1102-
- Custom routing with React Router
1103-
- Custom data adapter (not ObjectStack)
1104-
- Custom authentication
1105-
- Cherry-picking only needed components
1106-
- Building a console in ~100 lines of code
1107-
11081102
## Record create/edit modes
11091103

11101104
The default `<DefaultAppContent>` shell mounts a global `<ModalForm>` for

‎ui/packages/app-shell/src/console/ConsoleShell.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
* routing tree behind a config object. In practice every real project wants to
77
* edit the routes directly (add /billing, tweak AuthGuard behaviour, reorder
88
* providers), so we now export the pieces and let consumers write ~40 lines of
9-
* JSX in App.tsx. See examples/console-starter/src/App.tsx for a minimal example,
10-
* apps/console/src/App.tsx for one with custom system routes + CreateApp.
9+
* JSX in App.tsx. See apps/console/src/App.tsx, with custom system routes +
10+
* CreateApp.
1111
*/
1212

1313
import { Suspense, useEffect, useRef, useState, type ReactNode } from 'react';

‎ui/packages/app-shell/src/console/auth/signUpOffer.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* ONE decision for every such page (objectui#11705): the console's own
1414
* `/login` and `/register` (`apps/console/src/pages/auth/`) and this package's
1515
* exported `DefaultLoginPage` / `DefaultRegisterPage` (`./LoginPage`,
16-
* `./RegisterPage`, which `examples/console-starter` mounts) all call
16+
* `./RegisterPage`) all call
1717
* {@link decideSignUpOffer}. It was written for the console's pages and moved
1818
* here unchanged, so that a package page can call it too; there is no second
1919
* copy of the rule.

0 commit comments

Comments
 (0)