OzzyRM Landing

Marketing site and documentation for OzzyRM, the schema documentation toolkit for Prisma, Drizzle, and raw SQL.

Overview · Features · Getting started · Structure · Scripts · Related · Contributing · License

---

Overview

This repository is the public website for OzzyRM. It includes:

• Product landing pages (hero, features, FAQ, changelog entry points)
• Documentation powered by Fumadocs under /docs
• Shared brand assets (logo, favicon)

The npm library itself lives in a separate package: ozzyrm.

Features

• Next.js App Router marketing UI
• Fumadocs MDX docs with light and dark theme support
• Glossary and feature pages that mirror package capabilities
• Bun-first local development

Getting started

Requirements: Bun (recommended) or Node 20+.

bun install
bun dev

Open http://localhost:3000.

Docs entry redirects /docs to /docs/introduction.

Project structure

landing/
├── content/docs/     # MDX documentation
├── public/           # Static assets (logo, favicon, ORM marks)
├── src/app/          # Next.js routes (landing, docs, changelog)
├── src/components/   # UI sections and docs helpers
└── source.config.ts  # Fumadocs source config

Brand files:

File	Use
public/ozzyrm-logo.svg	Primary logo
public/favicon.ico	Site favicon (also src/app/favicon.ico)

Scripts

Command	Description
bun dev	Start local development server
bun run build	Production build
bun start	Serve the production build
bun run lint	Run ESLint

postinstall runs fumadocs-mdx to generate docs source files.

Related

Project	Role
ozzyrm on npm	Schema docs library (CLI + React UI)
Package source	Library repo used for releases and CI

Contributing

Issues and pull requests are welcome for docs typos, landing copy, and site bugs.

1. Fork and create a focused branch
2. Run bun install and bun dev
3. Open a PR with a short summary and screenshots when UI changes

Please keep branding consistent (logo, black and white marketing palette). Do not commit secrets or .env files.

License

MIT