## 1. Project Overview & Quickstart (novuhq/LICENSE)

## 1. Project Overview & Quickstart (novuhq/LICENSE)

# LICENSE

Open-source repository novuhq/LICENSE

### Repository Details
- **Repository:** [novuhq/LICENSE](https://github.com/novuhq/LICENSE)
- **Primary Language:** Code

*Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.*

## 2. Official Technical Reference & Guides (novuhq/docs)

<h1 align="center">The &lt;Inbox /&gt; infrastructure for modern products</h1>



  

# Documentation

## 🚀 Quick Start

Built with [Fumadocs](https://fumadocs.vercel.app/) and [pnpm](https://pnpm.io/).

**Prerequisites:** [Node.js](https://nodejs.org/) 22+, [pnpm](https://pnpm.io/installation) 11+, and [Vale](https://vale.sh/docs/install) 3.9.1+ (only needed if you want to run prose linting locally; CI installs it automatically)

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

Open [http://localhost:3010](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**

   ```bash
   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](https://github.com/novuhq/docs)
   - 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](https://github.com/novuhq/docs/issues)

  **Need Help?** conatct us at support@novu.co or join [Discord](https://discord.novu.co).

---

Thank you for contributing! 🙏

## 2. Official Technical Reference & Guides (novuhq/docs)

<h1 align="center">The &lt;Inbox /&gt; infrastructure for modern products</h1>



  

# Documentation

## 🚀 Quick Start

Built with [Fumadocs](https://fumadocs.vercel.app/) and [pnpm](https://pnpm.io/).

**Prerequisites:** [Node.js](https://nodejs.org/) 22+, [pnpm](https://pnpm.io/installation) 11+, and [Vale](https://vale.sh/docs/install) 3.9.1+ (only needed if you want to run prose linting locally; CI installs it automatically)

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

Open [http://localhost:3010](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**

   ```bash
   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](https://github.com/novuhq/docs)
   - 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](https://github.com/novuhq/docs/issues)

  **Need Help?** conatct us at support@novu.co or join [Discord](https://discord.novu.co).

---

Thank you for contributing! 🙏