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
# Object UI Documentation Site (Fumadocs Migration - In Progress)
2
2
3
-
This is the official documentation site for Object UI, built with [Fumadocs](https://fumadocs.vercel.app/).
3
+
This is the official documentation site for Object UI, being migrated to [Fumadocs](https://fumadocs.vercel.app/).
4
+
5
+
## Status
6
+
7
+
🚧 **Work in Progress** - The site structure is complete but there are issues with the fumadocs source API integration that need to be resolved.
8
+
9
+
### Completed
10
+
- ✅ Next.js 15 + TypeScript setup
11
+
- ✅ Tailwind CSS configuration
12
+
- ✅ Fumadocs UI integration
13
+
- ✅ MDX content processing
14
+
- ✅ Basic documentation pages created
15
+
- ✅ Homepage and layout structure
16
+
17
+
### Known Issues
18
+
- ⚠️ Route generation not working - investigating fumadocs 15.x API changes
19
+
- The `.source` output from fumadocs-mdx needs proper integration with loader
20
+
-`createMDXSource` API compatibility issue with runtime-processed docs/meta
4
21
5
22
## Development
6
23
7
24
```bash
8
25
# Install dependencies
9
26
pnpm install
10
27
11
-
# Start development server
28
+
# Start development server (NOTE: routes currently return 404)
12
29
pnpm dev
13
30
14
31
# Build for production
15
32
pnpm build
16
-
17
-
# Start production server
18
-
pnpm start
19
33
```
20
34
21
35
## Project Structure
@@ -36,32 +50,22 @@ apps/site/
36
50
└── source.config.ts # Fumadocs MDX configuration
37
51
```
38
52
39
-
## Features
40
-
41
-
- 📝 MDX-based documentation
42
-
- 🎨 Built with Tailwind CSS
43
-
- 🌗 Dark mode support
44
-
- 🔍 Full-text search (coming soon)
45
-
- 📱 Responsive design
46
-
- ⚡ Fast page loads with Next.js
47
-
48
-
## Adding Documentation
49
-
50
-
1. Create a new `.mdx` file in `content/docs/`
51
-
2. Add frontmatter with title and description:
52
-
```mdx
53
-
---
54
-
title: Your Page Title
55
-
description: Page description
56
-
---
57
-
58
-
# Your Content Here
59
-
```
60
-
3. Update `content/docs/meta.json` to add the page to navigation
53
+
## Technical Notes
54
+
55
+
The fumadocs-mdx compiler generates a `.source` directory with processed docs and meta exports. These are wrapped by `_runtime.doc()` and `_runtime.meta()` functions. The correct integration with fumadocs-core's `loader` and `createMDXSource` needs investigation based on fumadocs 15.x API.
56
+
57
+
## Next Steps
58
+
59
+
1. Investigate correct fumadocs 15.x API for integrating `.source` exports
0 commit comments