Oxiverse logo

Adding a Project

How to document a new project on this site.

Adding a new project to the docs is just a matter of creating a folder with Markdown files. Here is the full recipe.

1. Create the project folder

In the content/docs folder, create a new folder named after your project (use lowercase with dashes — it becomes the URL):

content/docs/
└── my-project/          ← new folder, URL: /docs/my-project

2. Add the pages

At minimum, add a meta.json and an index.mdx:

content/docs/my-project/meta.json — controls the sidebar order for this project:

{
  "pages": ["index", "getting-started", "api"]
}

content/docs/my-project/index.mdx — the project's landing page:

---
title: My Project
description: One line about what this project does.
---

Welcome to the **My Project** documentation.

<Cards>
  <Card title="Getting Started" href="/docs/my-project/getting-started" description="Start here." />
  <Card title="API" href="/docs/my-project/api" description="Reference." />
</Cards>

Every other page is just another .mdx file in the same folder. Save a file and it appears in the sidebar instantly.

3. Register it in the docs home

Open content/docs/meta.json and add the folder to the pages array:

{
  "pages": ["index", "intentforge", "ravana", "my-project", "adding-a-project"]
}

Then add a card for it on the Projects page so visitors can find it.

4. Optional: sub-groups inside a project

Bigger projects can have their own sub-folders, same pattern as the top level:

content/docs/my-project/
├── meta.json          → { "pages": ["index", "guides", "api"] }
├── index.mdx
├── guides/
│   ├── meta.json      → { "pages": ["deployment", "troubleshooting"] }
│   ├── deployment.mdx
│   └── troubleshooting.mdx
└── api.mdx

5. Renaming or removing a project

  • Rename: rename the folder (and the meta.json pages entries) — the URL follows the folder name.
  • Remove: delete the folder and drop it from content/docs/meta.json.

Tip

The fastest way to start a new project is to duplicate an existing project folder (for example intentforge or ravana) and rename the files inside.

On this page