|
1 | 1 | --- |
2 | | -title: Introduction |
3 | | -description: The Metadata-Driven Documentation Engine for the Low-Code Era. |
| 2 | +title: Test |
| 3 | +description: Test page |
4 | 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="Low-Code Native" |
29 | | - href="/docs/components" |
30 | | - > |
31 | | - Directly embed JSON schemas in Markdown. Render live, interactive components powered by 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 `content/docs.site.json` (branding, nav links). |
42 | | -* **Frontend Developers**: Maintain the base UI logic only when strictly necessary. |
43 | | - |
44 | | -### 2. Interactive Components |
45 | | -Static text is not enough to showcase the capabilities of a low-code platform. ObjectDocs allows you to mount live component demos directly in your docs. |
46 | | - |
47 | | -## Next Steps |
48 | | - |
49 | | -Ready to build your documentation? |
50 | | - |
51 | | -<Cards> |
52 | | -<Card title="Quick Start" href="/docs/getting-started" icon={<Zap />}> |
53 | | -Install ObjectDocs and create your first page in under 5 minutes. |
54 | | -</Card> |
55 | | -<Card title="Architecture" href="/docs/getting-started/architecture" icon={<Layers />}> |
56 | | -Deep dive into the directory structure and data flow. |
57 | | -</Card> |
58 | | -</Cards> |
| 5 | +# Test Page |
0 commit comments