Skip to content

Commit 804bcc6

Browse files
committed
docs(sdk): satisfy the docs gates on the moved pages — one h1, tsx fences, named sections, audit scope
Claude-Session: https://claude.ai/code/session_01L9qibzngYyRjmvNxjkfVyd Co-authored-by: Claude <noreply@anthropic.com>
1 parent 3fdc663 commit 804bcc6

17 files changed

Lines changed: 112 additions & 37 deletions

‎content/docs/sdk/api/schema-reference.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: "Schema Type Reference"
33
description: "Complete API reference for all ObjectUI schema types with annotated examples"
44
---
55

6-
# Schema Type Reference
7-
86
This reference documents every ObjectUI schema type with annotated JSON examples. Each schema extends `BaseSchema` and can be rendered by the ObjectUI engine from pure JSON.
97

108
> **Import:** All types are available from `@object-ui/types`.
@@ -875,10 +873,12 @@ An authored `object-form` node takes its props in its `properties` bag, whose me
875873
"fields": ["firstName", "lastName", "email", "phone", "company"],
876874
"sections": [
877875
{
876+
"name": "basic_info",
878877
"label": "Basic Info",
879878
"fields": ["firstName", "lastName", "email"]
880879
},
881880
{
881+
"name": "details",
882882
"label": "Details",
883883
"fields": ["phone", "company", "address"]
884884
}
@@ -1183,6 +1183,7 @@ An enhanced detail view for a single record with sections, tabs and navigation.
11831183
"deleteConfirmation": "Are you sure you want to delete this contact?",
11841184
"sections": [
11851185
{
1186+
"name": "personal_information",
11861187
"title": "Personal Information",
11871188
"icon": "User",
11881189
"columns": 2,

‎content/docs/sdk/guide/architecture-overview.mdx‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Architecture Overview
33
description: Deep dive into the ObjectUI 3-layer architecture, data flow, plugin system, state management, and action system.
44
---
55

6-
# Architecture Overview
7-
86
ObjectUI is a **Server-Driven UI (SDUI) engine** that transforms JSON schemas into fully interactive React interfaces built on Shadcn/Tailwind. This document covers the internal architecture, data flow, and extension points.
97

108
## The 3-Layer Architecture
@@ -150,7 +148,7 @@ Plugins use `React.lazy()` wrapped by `LazyPluginLoader` (`packages/react/src/La
150148

151149
Every plugin follows the same structure (see `packages/plugin-kanban/`, `packages/plugin-grid/`):
152150

153-
```typescript
151+
```tsx
154152
// 1. Lazy-load the heavy implementation
155153
const LazyKanban = React.lazy(() => import('./KanbanImpl'));
156154

‎content/docs/sdk/guide/building-crud-app.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: "Building a CRUD App"
33
description: "End-to-end tutorial for building a complete CRUD application with ObjectUI — from schema definition to deployment"
44
---
55

6-
# Building a CRUD App
7-
86
This tutorial walks you through building a **Task Manager** CRUD application with ObjectUI — from schema definition to data source setup to deployment.
97

108
## Prerequisites

‎content/docs/sdk/guide/layout.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: "Layout System"
33
description: "Understanding ObjectUI's layout components for building application shells and page structures"
44
---
55

6-
# Layout System
7-
86
ObjectUI provides a comprehensive layout system through the `@object-ui/layout` package. This guide explains how to use layout components to build professional application structures.
97

108
## Overview

‎content/docs/sdk/guide/plugins.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ Add a line only for the plugins you install. The other `@object-ui/plugin-*` pac
220220

221221
Plugins use React's `lazy()` and `Suspense` to load heavy dependencies on-demand:
222222

223-
```typescript
223+
```tsx
224224
// The plugin structure
225225
import React, { Suspense } from 'react'
226226
import { Skeleton } from '@object-ui/components'
@@ -301,7 +301,7 @@ cd packages/plugin-myfeature
301301

302302
### 2. Create Heavy Implementation
303303

304-
```typescript
304+
```tsx
305305
// src/MyFeatureImpl.tsx
306306
import HeavyLibrary from 'heavy-library'
307307

@@ -312,7 +312,7 @@ export default function MyFeatureImpl(props) {
312312

313313
### 3. Create Lazy Wrapper
314314

315-
```typescript
315+
```tsx
316316
// src/index.tsx
317317
import React, { Suspense } from 'react'
318318
import { ComponentRegistry } from '@object-ui/core'
@@ -437,7 +437,7 @@ Heavy imports go in the `*Impl.tsx` file.
437437

438438
Always show a meaningful skeleton while loading:
439439

440-
```typescript
440+
```tsx
441441
<Suspense fallback={
442442
<Skeleton className="w-full h-[400px]" />
443443
}>

‎content/docs/sdk/guide/quick-start.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: "Quick Start"
33
description: "Get up and running with ObjectUI in 5 minutes - install, configure, and render your first server-driven UI"
44
---
55

6-
# Quick Start
7-
86
Get up and running with ObjectUI in a small Vite app. This guide installs the core renderer, registers the built-in component packages, and renders a first JSON schema.
97

108
## Prerequisites

‎content/docs/sdk/guide/schema-overview.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: "Schema Overview"
33
description: "Comprehensive overview of ObjectUI schemas for building enterprise applications"
44
---
55

6-
# Schema Overview
7-
86
ObjectUI provides powerful schemas that enable you to build sophisticated enterprise applications with advanced features like theming, reporting, and complex workflows. This guide provides an overview of all available schemas and helps you get started quickly.
97

108
## Key Capabilities

‎content/docs/sdk/guide/theming.mdx‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: "Theming & Customization"
33
description: "Customize the look-and-feel of ObjectUI components with CSS custom properties, Tailwind CSS, cva variants, and runtime theme switching"
44
---
55

6-
# Theming & Customization
7-
86
ObjectUI's theming system is built on three layers: **CSS custom properties** (design tokens), **Tailwind CSS** (utility classes), and **class-variance-authority** (component variants). Together they give you full control over appearance — from global palettes down to individual component states.
97

108
## How Theming Works
@@ -264,7 +262,7 @@ Start from HSL values and define both light and dark variants:
264262
```tsx
265263
import type { Theme } from "@object-ui/types";
266264

267-
export const brand: Theme = {
265+
export const brand = {
268266
name: "brand",
269267
label: "Brand",
270268
colors: {
@@ -292,7 +290,7 @@ export const brand: Theme = {
292290
ring: "262 83% 58%",
293291
},
294292
borderRadius: { base: "0.5rem" }, // --radius
295-
};
293+
} satisfies Theme;
296294
```
297295

298296
> **Tip:** Use the [Shadcn Themes tool](https://ui.shadcn.com/themes) to generate a full palette, then paste the HSL values into your Theme object.

‎content/docs/sdk/guide/troubleshooting.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Troubleshooting
33
description: Solutions to common issues when building with ObjectUI.
44
---
55

6-
# Troubleshooting
7-
86
This guide covers the most common issues you may encounter when working with ObjectUI, along with their solutions.
97

108
## 1. "Component type X not found"

‎content/docs/sdk/plugins/index.mdx‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: "Plugin Gallery"
33
description: "Explore all ObjectUI plugins for extended functionality"
44
---
55

6-
# Plugin Gallery
7-
86
ObjectUI plugins are lazy-loaded component packages that extend the framework with additional functionality. They load on-demand, keeping your main application bundle small while providing rich features.
97

108
## Quick Navigation
@@ -283,7 +281,7 @@ npm install @object-ui/plugin-view
283281

284282
Plugins use React's `lazy()` and `Suspense` to load heavy dependencies on-demand:
285283

286-
```typescript
284+
```tsx
287285
// The plugin structure
288286
import React, { Suspense } from 'react'
289287
import { Skeleton } from '@object-ui/components'

0 commit comments

Comments
 (0)