The <Inbox /> infrastructure for modern products

The notification platform that turns complex multi-channel delivery into a single component. Built for developers, designed for growth, powered by open source.

Visit our main GitHub Repository »

Documentation

🚀 Quick Start

Built with Fumadocs and pnpm.

Prerequisites: Node.js 20+, pnpm, and Vale 3.9.1+ (only needed if you want to run prose linting locally; CI installs it automatically)

# Clone and setup
git clone https://github.com/YOUR_USERNAME/docs.git
cd docs
pnpm install
pnpm dev

Open http://localhost:3010 to view locally.

Scripts:

• pnpm dev - Development server
• pnpm build - Production build
• pnpm lint - Lint code
• pnpm lint:prose:sync - Download Vale style packages (run once after install)
• pnpm lint:prose - Run Vale prose linting against content/ (requires Vale on PATH)

🤝 Contributing

1. Make Changes

   git checkout -b feature/your-fix
   # Edit files
   pnpm dev  # Test locally
   git commit -m "docs: your changes"
   git push origin feature/your-fix

2. Create Pull Request

   • Go to GitHub repo
   • Click "New Pull Request"
   • Use descriptive title with docs:, fix:, or feat: prefix
   • Include screenshots for visual changes

Guidelines:

• Write clear, concise documentation

• Test code examples before submitting

• Follow existing file structure

• Is something missing in docs? create a new github issue

  Need Help? conatct us at support@novu.co or join Discord.

---

Thank you for contributing! 🙏