Skip to content

Commit 562322e

Browse files
Copilothotlong
andcommitted
docs: Update README with current status and known issues
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 48d5cdc commit 562322e

3 files changed

Lines changed: 35 additions & 29 deletions

File tree

apps/site/README.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,35 @@
1-
# Object UI Documentation Site
1+
# Object UI Documentation Site (Fumadocs Migration - In Progress)
22

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
421

522
## Development
623

724
```bash
825
# Install dependencies
926
pnpm install
1027

11-
# Start development server
28+
# Start development server (NOTE: routes currently return 404)
1229
pnpm dev
1330

1431
# Build for production
1532
pnpm build
16-
17-
# Start production server
18-
pnpm start
1933
```
2034

2135
## Project Structure
@@ -36,32 +50,22 @@ apps/site/
3650
└── source.config.ts # Fumadocs MDX configuration
3751
```
3852

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
60+
2. Fix route generation to resolve 404 errors
61+
3. Add search functionality
62+
4. Migrate remaining documentation content
63+
5. Set up deployment
6164

6265
## Tech Stack
6366

6467
- [Next.js 15](https://nextjs.org/) - React framework
6568
- [Fumadocs](https://fumadocs.vercel.app/) - Documentation framework
6669
- [Tailwind CSS](https://tailwindcss.com/) - Styling
6770
- [TypeScript](https://www.typescriptlang.org/) - Type safety
71+

apps/site/app/docs/[[...slug]]/page.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ export default async function Page({
1717
const page = source.getPage(slug);
1818
if (!page) notFound();
1919

20+
// Type assertion needed due to custom data mapping
2021
const MDX = (page.data as any).body;
2122

2223
return (

apps/site/lib/source.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@ import { loader } from 'fumadocs-core/source';
22
import { docs } from '@/.source';
33

44
// Map the docs from .source to the format expected by loader
5+
// Note: docs from .source is wrapped by _runtime.doc(), not a plain array
56
const mappedDocs = docs
67
.filter((doc: any) => doc && doc.info && doc.info.path)
78
.map((doc: any) => {
89
let path = doc.info.path.replace(/\.mdx?$/, '');
9-
// Convert index.mdx to empty path
10+
// Convert index.mdx to empty path for root /docs route
1011
if (path === 'index') path = '';
1112

1213
return {

0 commit comments

Comments
 (0)