mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-15 12:50:42 -07:00
3.2 KiB
3.2 KiB
Documentation Migration: Mintlify → Fumadocs
This document summarizes the migration of documentation from /docs (Mintlify) to /docs2 (Fumadocs).
What Was Done
1. Files Copied
- ✅ All 29 MDX files from
/docsfolders (overview, api, developer, plans) - ✅ All 4 root-level markdown files (AUTOUPDATER.md, AUTOUPDATER_QUICKSTART.md, TROUBLESHOOTING.md, README.md)
- ✅ All images (3 webp files) →
public/images/ - ✅ All logo files (2 png files) →
public/logo/
2. Component Migration
Created compatibility layer in components/mintlify-compat.tsx that maps Mintlify components to Fumadocs equivalents:
<Frame>→ Simple div wrapper (images are zoomable by default in Fumadocs)<CardGroup>→<Cards>(Fumadocs component)<Card>→<Card>(with icon string → Lucide icon mapping)<Steps>/<Step>→ Direct mapping to Fumadocs components<Tip>,<Note>,<Info>→<Callout type="info"><Warning>→<Callout type="warn"><Danger>→<Callout type="error"><AccordionGroup>/<Accordion>→ HTML<details>/<summary>elements
3. Navigation Structure
Created meta.json files for each folder:
content/docs/meta.json- Root documentationcontent/docs/overview/meta.json- Overview pagescontent/docs/api/meta.json- API referencecontent/docs/developer/meta.json- Developer docscontent/docs/plans/meta.json- Plans/roadmap
4. Link Fixes
- Fixed incorrect
/guides/...paths →/overview/... - All internal links now use correct paths
5. Branding
- Updated
lib/layout.shared.tsxto use "Voicebox" as the nav title
File Structure
docs2/
├── components/
│ └── mintlify-compat.tsx # Mintlify → Fumadocs component mappings
├── content/docs/
│ ├── meta.json # Root navigation
│ ├── overview/ # 12 MDX files
│ ├── api/ # 5 MDX files
│ ├── developer/ # 12 MDX files
│ ├── plans/ # 4 MD files
│ └── *.md # 4 root markdown files
├── public/
│ ├── images/ # 3 webp files
│ └── logo/ # 2 png files
└── mdx-components.tsx # MDX component configuration
Icon Mapping
The following icon strings are mapped to Lucide icons:
microphone→ Micfilm→ Filmcode→ Codeshield→ Shielddownload→ Downloadrocket→ Rocketapple→ Applewindows→ Windowsserver→ Serveruser→ Userwaveform→ Waveform
Next Steps
- Test the build: Run
npm run build(requires Node.js >= 20.9.0) - Start dev server: Run
npm run devto preview - Customize styling: Update
app/global.cssif needed - Add more icons: Extend
iconMapinmintlify-compat.tsxas needed - Review navigation: Adjust
meta.jsonfiles to customize page order
Notes
- Image paths (
/images/...) work as-is since Next.js serves frompublic/ - All Mintlify components are now compatible with Fumadocs
- Navigation structure follows Fumadocs conventions
- No breaking changes to content - all MDX files work with compatibility layer