You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: add changeset configuration and release workflow
- Created a README.md file in the .changeset directory for documentation.
- Added a config.json file to configure changesets with default settings.
- Introduced a GitHub Actions workflow for automated releases on main branch pushes.
<img src="https://vercel.com/button" alt="Deploy with Vercel" />
26
+
</a>
13
27
</div>
14
28
15
29
---
16
30
17
31
## 📖 Introduction
18
32
19
-
**ObjectDocs** is a moderndocumentation site generator built on top of **Next.js (App Router)** and **Fumadocs**.
33
+
**ObjectDocs** is a modern, metadata-driven documentation engine architected for the **ObjectStack** ecosystem. Built on top of **Next.js 14 (App Router)** and **Fumadocs**, it redefines how enterprise documentation is maintained.
20
34
21
-
Unlike traditional static site generators, ObjectDocs adopts a strict **Metadata-Driven Architecture**. We completely separate the **Presentation Layer** (React), **Configuration Layer** (JSON), and **Content Layer** (MDX). This allows developers and technical writers to manage complex, multi-product documentation sites purely through configuration files, without touching a single line of UI code.
35
+
Unlike traditional static site generators, ObjectDocs adopts a strict **Separation of Concerns** philosophy:
36
+
***Presentation**: Handled by a standardized, logic-free React layer.
37
+
***Configuration**: Defined purely in JSON (`site.json`, `meta.json`).
38
+
***Content**: Written in MDX with native support for low-code components.
22
39
23
-
It is designed specifically for the **Low-Code ecosystem**, with native support for embedding **Amis** and **Steedos** components directly into your Markdown.
40
+
This architecture allows developers and technical writers to manage complex, multi-product documentation sites without touching a single line of UI code.
24
41
25
42
## ✨ Key Features
26
43
27
-
***🚀 Metadata-Driven Core**: Control navigation, sidebars, SEO, and branding entirely via `site.json` and `meta.json`.
***🗂️ Multi-Product Architecture**: Native support for "Root Toggle" to manage documentation for multiple products (e.g., Core vs. UI) in one repo.
30
-
***🎨 Enterprise UI**: Built on **Radix UI** and **Tailwind CSS**, featuring dark mode, spotlight effects, and accessible primitives.
31
-
***⚡ High Performance**: Powered by Next.js App Router and ISR (Incremental Static Regeneration).
44
+
***🚀 Metadata-Driven Architecture**
45
+
Control navigation, sidebars, SEO, and branding entirely via `objectdocs.json` and local `meta.json` files. Zero React knowledge required for content maintainers.
46
+
47
+
***🧩 Low-Code Native**
48
+
Seamlessly embed live, interactive **Amis** and **Steedos** components directly within your Markdown. Perfect for showcasing live demos of low-code configurations.
49
+
50
+
***🗂️ Multi-Product Support**
51
+
Native implementation of "Root Toggle" modes, allowing you to host documentation for multiple products (e.g., `ObjectQL` vs. `ObjectUI`) within a single monorepo and domain.
52
+
53
+
***🎨 Enterprise-Grade UI**
54
+
Polished interface built on **Radix UI** and **Tailwind CSS**, featuring automatic dark mode, spotlight effects, and accessible primitives out of the box.
55
+
56
+
***⚡ Edge Performance**
57
+
Powered by Next.js App Router and ISR (Incremental Static Regeneration), ensuring instant page loads and excellent SEO.
32
58
33
59
## 🏗️ Architecture
34
60
35
-
ObjectDocs enforces a strict separation of concerns to ensure maintainability:
61
+
ObjectDocs enforces a clear directory structure to ensure maintainability at scale:
36
62
37
63
```text
38
64
.
39
-
├── content/ # [Data] Raw Content
40
-
│ └── docs/
41
-
│ ├── meta.json # Directory structure & sorting
42
-
│ └── index.mdx # Documentation files
43
-
└── app/ # [View] Logic-free Rendering Layer
44
-
└── layout.tsx # Consumes config/site.json to render UI
45
-
├── objectdocs.json # Global settings (Nav, Logo, SEO, Features)
65
+
├── content/ # [Data Layer] Raw Content
66
+
│ └── docs/
67
+
│ ├── meta.json # Directory structure & sorting control
68
+
│ └── index.mdx # Documentation content
69
+
├── config/ # [Config Layer]
70
+
│ └── site.json # Global settings (Nav, Logo, Branding)
71
+
└── app/ # [View Layer] Logic-free Rendering
72
+
└── layout.tsx # Consumes config to render UI
46
73
47
74
```
48
75
@@ -51,7 +78,7 @@ ObjectDocs enforces a strict separation of concerns to ensure maintainability:
Contributions are welcome! Please read our [Contributing Guide](./CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
130
159
131
160
## 📄 License
132
161
133
-
This project is licensed under the MIT License - see the [LICENSE](https://www.google.com/search?q=MIT) file for details.
162
+
This project is licensed under the MIT License - see the [LICENSE](https://www.google.com/search?q=MIT) file for details.
0 commit comments