Reference Documentation
Information-oriented technical reference material for quick lookups.
What is Reference Documentation?
Reference docs provide exact, factual information about APIs, configurations, and technical specifications. They are designed for quick lookups when you know what you're looking for.
Characteristics:
- ✅ Exhaustive and complete
- ✅ Dry, factual (no narrative)
- ✅ Logically organized
- ✅ Searchable and indexable
- ✅ Auto-generated when possible
When to use:
- You need exact syntax or parameters
- You're looking up configuration options
- You need to verify API signatures
- You want a complete list of available options
Reference Sections
📡 API Reference
Complete API documentation with all endpoints, queries, and mutations.
- GraphQL Schema - Full GraphQL API reference
- MCP Tools Reference - All 4 MCP tools with parameters
- REST Endpoints - Health checks and OAuth endpoints
🗄️ Database Reference
Database schema and data models.
- Prisma Schema - All 29 database models
- Migrations Guide - Migration history and commands
⚙️ Configuration Reference
All configuration options and settings.
- Environment Variables - Complete .env reference
- OAuth Providers - Supported OAuth providers
- Docker Compose - Docker configuration reference
💻 CLI Reference
Command-line interface documentation.
- NPM Scripts - All package.json scripts explained
Difference from Other Doc Types
| Tutorials | How-To | Reference | Explanation |
|---|---|---|---|
| Learning | Problem-solving | Lookup | Understanding |
| Step-by-step | Task-focused | Factual | Conceptual |
| Narrative | Flexible | Exhaustive | Contextual |
Can't Find What You Need?
- Check Tutorials if you're learning
- Check How-To Guides for task guidance
- Check Explanation to understand concepts