Skip to content

docs(guide): objectstack.config.ts belongs to the server project — link it, do not re-type it (#5160)#5332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-support-ai merged 1 commit into from
Aug 19, 2026
+23 −67
Merged

docs(guide): objectstack.config.ts belongs to the server project — link it, do not re-type it (#5160) #5332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 13 additions & 66 deletions content/docs/guide/objectos-integration.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,72 +75,19 @@ export async function createKernel() {

### 3. Create ObjectStack Configuration

```typescript
// objectstack.config.ts
import type { AppManifest } from '@objectstack/spec';

export const manifest: AppManifest = {
name: 'my-app',
version: '1.0.0',
description: 'My ObjectUI + ObjectOS Application',

// Define your data objects
objects: {
contact: {
name: 'contact',
label: 'Contact',
fields: {
name: { name: 'name', label: 'Name', type: 'text', required: true },
email: { name: 'email', label: 'Email', type: 'email', required: true },
phone: { name: 'phone', label: 'Phone', type: 'phone' },
company: { name: 'company', label: 'Company', type: 'text' },
status: {
name: 'status',
label: 'Status',
type: 'select',
options: [
{ label: 'Active', value: 'active' },
{ label: 'Inactive', value: 'inactive' }
]
}
}
}
},

// Define UI pages
pages: [
{
name: 'contacts',
label: 'Contacts',
path: '/contacts',
icon: 'users',
component: {
type: 'object-view',
objectName: 'contact',
viewTypes: ['grid', 'kanban', 'calendar']
}
}
],

// Define app navigation
navigation: {
items: [
{
label: 'Dashboard',
path: '/',
icon: 'home'
},
{
label: 'Contacts',
path: '/contacts',
icon: 'users'
}
]
}
};

export default manifest;
```
`objectstack.config.ts` belongs to the **ObjectStack server project**, not to an
ObjectUI app. It is authored with `defineStack()` and compiled by the `os` CLI;
the packages it imports (`@objectstack/spec`, `@objectstack/runtime`, plugins)
are dependencies of that project, not of this one. ObjectUI is a pure consumer
of whatever the server publishes over the metadata API, so the authoritative
reference for this file lives on the ObjectStack side:

- [Your First Project](https://objectstack.ai/docs/getting-started/your-first-project) — the generated `objectstack.config.ts` walked through key by key: `manifest`, `plugins`, `objects`
- [Command Line Interface](https://objectstack.ai/docs/deployment/cli) — how the file is discovered, validated against `ObjectStackDefinitionSchema`, and compiled to a deployable `dist/objectstack.json`
- [Data Flow Diagrams](https://objectstack.ai/docs/api/data-flow) — how `defineStack()` becomes a running application

The rest of this guide is ObjectUI's half of the integration: rendering the
objects, views and apps that the server exposes.

### 4. Set Up Frontend with Console

Expand Down
11 changes: 10 additions & 1 deletion scripts/check-doc-snippet-types.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,7 +211,16 @@ const TS_FENCE_LANGUAGES = new Set(['ts', 'tsx', 'typescript']);
*/
const UNGATED_DOCS = {
'content/docs/guide/objectos-integration.mdx':
'36 parse diagnostic(s) — blocks fenced `ts` that are bare object literals or elided bodies; 10 undefined-name diagnostic(s) — blocks continue an earlier block, or use ambient names the page never defines; 7 unresolved-module diagnostic(s); plus TS2305x1 TS2339x1 — candidate real defects, un-triaged',
'36 parse diagnostic(s) — blocks fenced `ts` that are bare object literals or elided bodies; ' +
'10 undefined-name diagnostic(s) — blocks continue an earlier block, or use ambient names the ' +
'page never defines; 7 unresolved-module diagnostic(s); plus TS2339x1 — candidate real defects, ' +
'un-triaged. This entry read TS2305x1 until objectui#5160, whose last name was the ' +
'`AppManifest` annotation on an `objectstack.config.ts` literal. That block is gone rather ' +
'than re-typed: the file is a server-project config this repo neither owns nor builds, so the ' +
'section links to the ObjectStack documentation instead of restating its shape here. Covering ' +
'this page still needs the 8 parse-failing blocks re-fenced or declared, the undefined-name ' +
'blocks made self-contained, and the `@objectstack/*` runtime imports resolvable — none of ' +
'which this repo can do from here.',
'content/docs/plugins/plugin-calendar-view.mdx':
'2 unresolved-module diagnostic(s) — and NOT a defect: the page is a migration guide whose ' +
'"Before" blocks quote the retired `@object-ui/plugin-calendar-view` import on purpose. Covering ' +
Expand Down
Loading