README.md

API Documentation

Official documentation for the Whitepages API
View Documentation

---

Development

Prerequisites

• Bun (recommended) or Node.js 18+

Getting Started

# Install dependencies
bun install

# Start development server
bun run dev

Open http://localhost:3000 to view the documentation.

Generate API Reference

The API reference documentation is auto-generated from the OpenAPI spec:

bun run generate:openapi

This fetches the latest spec from https://api.whitepages.com/openapi.json and generates the MDX files.

Project Structure

├── content/docs/
│   ├── documentation/     # Getting Started & Guides
│   └── references/        # API Reference & SDK docs
├── scripts/generators/    # OpenAPI doc generation
├── src/
│   ├── app/              # Next.js app router
│   ├── components/       # React components
│   └── lib/              # Utilities and configs
└── public/               # Static assets

Contributing

See CONTRIBUTING.md for guidelines on code style, commit conventions, and how to submit changes.

Tech Stack

• Next.js - React framework
• Fumadocs - Documentation framework
• fumadocs-openapi - OpenAPI documentation generator