Skip to content

novuhq/docs

Repository files navigation


Product Hunt Hacker News npm downloads

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+ and pnpm

# 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

🤝 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 [email protected] or join Discord.


Thank you for contributing! 🙏