|
| 1 | +--- |
| 2 | +title: Introduction |
| 3 | +description: The Metadata-Driven Documentation Engine for the Low-Code Era. |
| 4 | +--- |
| 5 | + |
| 6 | +import { FileJson, Layers, Cpu, Zap } from 'lucide-react'; |
| 7 | + |
| 8 | +# What is ObjectDocs? |
| 9 | + |
| 10 | +**ObjectDocs** is a modern, opinionated documentation site generator built on top of **Next.js 14** and **Fumadocs**. |
| 11 | + |
| 12 | +It was created to solve a specific problem in the **ObjectStack** ecosystem: *How do we document complex, multi-product low-code platforms without drowning in frontend maintenance?* |
| 13 | + |
| 14 | +Unlike general-purpose static site generators (SSGs), ObjectDocs treats documentation structure as **data**, not code. |
| 15 | + |
| 16 | +## Core Philosophy |
| 17 | + |
| 18 | +<Cards> |
| 19 | + <Card |
| 20 | + icon={<FileJson />} |
| 21 | + title="Metadata-Driven" |
| 22 | + href="/docs/getting-started/configuration" |
| 23 | + > |
| 24 | + Control sidebars, navigation, and page ordering entirely through local `meta.json` files. No React knowledge required for content updates. |
| 25 | + </Card> |
| 26 | + <Card |
| 27 | + icon={<Cpu />} |
| 28 | + title="ObjectUI Native" |
| 29 | + href="/docs/components/objectui-embed" |
| 30 | + > |
| 31 | + First-class support for embedding **ObjectUI** JSON schemas directly into Markdown. Render live, interactive components powered by your ObjectQL definitions. |
| 32 | + </Card> |
| 33 | +</Cards> |
| 34 | + |
| 35 | +## Why ObjectDocs? |
| 36 | + |
| 37 | +### 1. Separation of Concerns |
| 38 | +In traditional documentation sites, adding a new section often requires editing a global `sidebar.js` config or touching React components. In ObjectDocs, we strictly separate roles: |
| 39 | + |
| 40 | +* **Technical Writers**: Write `.mdx` content and manage local `meta.json` for sorting. |
| 41 | +* **Platform Architects**: Configure global `site.json` (branding, nav links). |
| 42 | +* **Frontend Developers**: Maintain the `app/` directory (layout, logic) only when strictly necessary. |
| 43 | + |
| 44 | +### 2. Multi-Product Architecture |
| 45 | +ObjectDocs is designed for monorepos that host multiple products (e.g., **ObjectQL**, **ObjectUI**, **ObjectOS**). It supports a "Root Toggle" mode that allows users to switch product contexts easily while staying on the same domain. |
| 46 | + |
| 47 | +### 3. Interactive by Default |
| 48 | +Static text isn't enough for low-code platforms. ObjectDocs allows you to mount live **ObjectUI** components directly in your docs to demonstrate protocol capabilities: |
| 49 | + |
| 50 | +```json title="example-objectui.json" |
| 51 | +{ |
| 52 | + "component": "ObjectGrid", |
| 53 | + "props": { |
| 54 | + "object": "contracts", |
| 55 | + "columns": ["name", "amount", "status", "created_by"], |
| 56 | + "filters": [ |
| 57 | + { "field": "status", "operator": "=", "value": "active" } |
| 58 | + ] |
| 59 | + } |
| 60 | +} |
| 61 | + |
| 62 | +``` |
| 63 | + |
| 64 | +<Callout type="info"> |
| 65 | +The actual rendering of the above JSON happens via our custom `ObjectUIRenderer` component. Check the [Components Guide](https://www.google.com/search?q=/docs/components) to learn more about schema validation and previewing. |
| 66 | +</Callout> |
| 67 | + |
| 68 | +## Next Steps |
| 69 | + |
| 70 | +Ready to build your documentation? |
| 71 | + |
| 72 | +<Cards> |
| 73 | +<Card title="Quick Start" href="/docs/getting-started/installation" icon={<Zap />}> |
| 74 | +Install ObjectDocs and create your first page in under 5 minutes. |
| 75 | +</Card> |
| 76 | +<Card title="Architecture" href="/docs/getting-started/architecture" icon={<Layers />}> |
| 77 | +Deep dive into the directory structure and data flow. |
| 78 | +</Card> |
| 79 | +</Cards> |
0 commit comments