# Rhombus Developer Documentation

This is a Mintlify documentation site for Rhombus security platform API documentation. The project provides comprehensive developer resources for integrating with Rhombus cameras, sensors, access control systems, and analytics.

## Project Overview

**Platform**: Mintlify documentation framework
**Purpose**: Developer documentation for Rhombus REST API
**Target Audience**: Developers building integrations with Rhombus security platform
**API Coverage**: 863+ endpoints across cameras, access control, environmental monitoring, events, and integrations

## Key Features

- **Comprehensive API Reference**: Auto-generated from OpenAPI specification
- **Interactive Documentation**: Mintlify components for rich user experience
- **Automated Updates**: Nightly sync with production API specification
- **Developer Resources**: Quick start guides, code examples, best practices
- **Multi-language Support**: Examples in cURL, Python, JavaScript, Go

## Architecture

### Core Structure
```
├── docs.json                 # Mintlify configuration
├── index.mdx                 # Homepage with API overview
├── quickstart.mdx           # Getting started guide
├── development.mdx          # Local development setup
├── api-reference/           # API documentation
│   ├── README.md           # API reference overview
│   ├── openapi.json        # Rhombus OpenAPI spec (863 endpoints)
│   └── endpoint/           # Generated endpoint documentation
├── implementations/         # Implementation examples
└── scripts/                # Maintenance scripts
```

### Navigation Structure

## Technical Implementation

### API Integration
- **Base URL**: `https://api2.rhombussystems.com`
- **Authentication**: API key via `x-auth-apikey` header
- **Rate Limits**: 1000 requests/hour, 100 requests/minute burst
- **OpenAPI Source**: `https://api2.rhombussystems.com/api/openapi/public.json`

### Maintenance
- **Manual Updates**: `scripts/update-openapi.sh` for on-demand spec updates
- **Validation**: JSON validation and change detection

### Development Workflow
```bash
# Install Mintlify CLI
npm i -g mint

# Local development
mint dev                    # Runs on localhost:3000
mint dev --port 3333       # Custom port

# Maintenance
mint update                 # Update CLI
mint broken-links          # Validate links
./scripts/update-openapi.sh # Update API spec
```

## Content Guidelines

### File Structure
All MDX files require YAML frontmatter:
```yaml
---
title: "Page Title"
description: "Brief description"
icon: "icon-name"          # Optional
---
```

### Mintlify Components
- **Callouts**: `<Note>`, `<Tip>`, `<Warning>`, `<Info>`, `<Check>`
- **Structure**: `<Steps>`, `<Tabs>`, `<AccordionGroup>`, `<Card>`, `<CardGroup>`
- **Code**: `<CodeGroup>`, `<RequestExample>`, `<ResponseExample>`
- **API**: `<ParamField>`, `<ResponseField>`, `<Expandable>`
- **Media**: `<Frame>` for images, `<video>`, `<iframe>`

## API Categories

### Core Services
- **Access Control Integrations**: 75 endpoints
- **Access Control**: 62 endpoints
- **Camera**: 59 endpoints
- **Component**: 59 endpoints
- **Policy**: 49 endpoints

### Events & Monitoring
- **Event**: 42 endpoints
- **Alert Monitoring**: 11 endpoints
- **Face Recognition Matchmaker**: 9 endpoints
- **Face Recognition Person**: 8 endpoints

### Integrations
- **Access Control Integrations**: 75 endpoints
- **Incident Management Integrations**: 34 endpoints

## Branding & Theme

### Color Scheme (2024 Rebrand)
- **Primary**: #2563EB (blue)
- **Light**: #60A5FA (light blue)
- **Dark**: #1D4ED8 (dark blue)

### Brand Identity
- Company name: "Rhombus" (dropped "Systems" in 2024 rebrand)
- Focus on trust, integrity, friendliness, and innovation
- Modern blue gradient replacing previous green theme

## Development Environment

### Prerequisites
- Node.js version 19 or higher
- Mintlify CLI installed globally
- Access to Rhombus Console for API key generation

### Local Development
1. Clone repository
2. Install Mintlify CLI: `npm i -g mint`
3. Run development server: `mint dev`
4. Access at `http://localhost:3000`

### Deployment
- Automatic deployment via Mintlify GitHub app integration
- Changes deploy to production on push to default branch
- No build step required - Mintlify handles compilation

## Key Files

### Configuration
- `docs.json`: Mintlify site configuration with navigation structure
- `scripts/update-openapi.sh`: Manual API spec update script

### Documentation
- `index.mdx`: Homepage with API overview and getting started
- `quickstart.mdx`: 5-minute quick start guide with code examples
- `development.mdx`: Local development setup instructions
- `api-reference/README.md`: API reference documentation process

### Assets
- `favicon.svg`: Site favicon
- `logo/`: Brand logos (dark/light variants)
- `images/`: Documentation screenshots and assets

This project serves as the primary developer resource for Rhombus API integration, providing comprehensive documentation, interactive examples, and automated maintenance of API specifications.