Skip to content

Repository files navigation

Oxiverse Documentation

The documentation website for Oxiverse — the platform where every universe connects.

Built with Fumadocs on top of Next.js (App Router) and MDX.

Getting started

npm install
npm run dev

Open http://localhost:3000 to view the site. The docs live at http://localhost:3000/docs.

Writing documentation

The site documents every Oxiverse project — each project is a folder in content/docs:

content/docs/
├── meta.json            ← top-level sidebar order
├── index.mdx            ← “Projects” overview page
├── intentforge/         ← one folder per project (synced from the repo)
│   ├── meta.json        ← this project's sidebar order
│   ├── index.mdx
│   └── api-reference.mdx
├── ravana/              ← another synced project
│   ├── meta.json
│   ├── index.mdx
│   └── architecture.mdx
└── adding-a-project.mdx ← guide for adding new projects

To document a new project:

  1. Create a folder in content/docs (name becomes the URL).
  2. Add a meta.json and .mdx pages inside it — they appear in the sidebar automatically.
  3. List the folder in content/docs/meta.json and add a card on the Projects page.

Full instructions live at /docs/adding-a-project. Frontmatter drives the title and description:

---
title: My Page
description: A short summary shown under the title.
---

Content goes here.

Project structure

Path Purpose
content/docs Your documentation content (Markdown / MDX).
app/(home) The landing page.
app/docs The documentation layout and page renderer.
lib/source.ts Content source configuration.
lib/layout.shared.tsx Shared nav/sidebar options, including the logo.
app/global.css Theme, including the Oxiverse brand colors.
public/oxiverse-logo.svg The Oxiverse logo used in the nav and favicon.

Commands

Command Description
npm run dev Start the development server.
npm run build Production build.
npm run start Serve the production build.
npm run types:check Run the TypeScript type checker.

Learn more

Releases

Packages

Contributors

Languages