Contributing to HYVE Docs

This guide explains how to add docs for a new product to HYVE Docs.

How It Works

HYVE Docs uses a convention-based multi-product architecture. Adding a new product requires:

A content directory with MDX files
A meta.json for navigation
A product tab entry

No code changes to loaders, configs, or routing are needed.

Adding a New Product

Create the Content Directory

Create a new directory under content/ with your product slug:

content/
├── dump/          # Existing product
├── brain/         # Your new product
│   ├── meta.json
│   ├── index.mdx
│   └── getting-started.mdx

Create meta.json

Every product directory needs a meta.json that defines the sidebar navigation:

content/brain/meta.json

{
  "title": "Brain",
  "icon": "Brain",
  "pages": [
    "index",
    "getting-started",
    "---Features---",
    "features",
    "---API Reference---",
    "api",
    "---Guides---",
    "guides"
  ]
}

title: Product name shown in the sidebar
icon: Icon name from Lucide (optional)
pages: Ordered list of pages and section separators (---Label---)

Create index.mdx

The index page is the product overview. Every MDX file needs frontmatter:

content/brain/index.mdx

---
title: Brain
description: Short description for search results and meta tags.
---

Required frontmatter:

Field	Type	Description
`title`	`string`	Page title (shown in sidebar, breadcrumbs, browser tab)
`description`	`string`	Used for search indexing, meta tags, and OG images

Add Recommended Sections

Follow the standard product structure:

Directory	Purpose
`index.mdx`	Product overview with key features
`getting-started.mdx`	Prerequisites, installation, first steps
`features/`	One page per major feature
`api/`	One page per API endpoint group
`guides/`	How-to guides and tutorials

Each subdirectory needs its own meta.json:

content/brain/features/meta.json

{
  "title": "Features",
  "pages": ["search", "chat", "agents"]
}

Register in Product Tabs

Add your product to the tabs component:

src/components/nav/product-tabs.tsx

const products = [
  { slug: 'dump', label: 'Dump' },
  { slug: 'brain', label: 'Brain' },  // Add your product
]

Build and Verify

pnpm --filter docs build

Verify that:

Your product appears in the sidebar product tabs
All pages render correctly
Navigation between products works
Search indexes your new content

Available MDX Components

All pages have access to these components without imports:

Component	Usage
`<Callout>`	Info, warning, tip, error callouts
`<Tabs>` / `<Tab>`	Tabbed content (e.g., npm/pnpm/yarn)
`<Steps>` / `<Step>`	Numbered step-by-step guides
`<Cards>` / `<Card>`	Linked card grids
`<Accordion>` / `<Accordions>`	Collapsible sections
`<Files>` / `<File>` / `<Folder>`	File tree display
`<TypeTable>`	TypeScript type documentation tables
`<HttpBadge>`	HTTP method badges (GET, POST, etc.)

See the Component Test page for live examples.

On this page