QPub Documentation

This repository contains the content source for the QPub documentation, written in MDX format.

Structure

The documentation is organized into the following main sections:

• Introduction - Overview of QPub, usage guides, performance information, and changelog
• Quick Start - Getting started guides for various programming languages and frameworks
• Core Concepts - Fundamental concepts including authentication
• References - API documentation for REST and Socket SDKs, endpoints, and examples
• Dashboard - User interface documentation for accounts, projects, API keys, and console
• Enterprise - Enterprise features including administration, user management, and scaling
• Community - Contribution guidelines and community resources

Content Format

All documentation content is written in MDX (Markdown with JSX) format, allowing for rich interactive components and enhanced markdown capabilities.

Navigation

The documentation structure is defined in sidebar.json, which organizes the content hierarchy and navigation flow.

Getting Started

To contribute to this documentation:

1. Create or edit MDX files in the appropriate directory
2. Update sidebar.json if adding new sections or reorganizing content
3. Follow the established directory structure and naming conventions

Directory Structure

docs/
├── intro/           # Introduction and overview content
├── quickstart/      # Getting started guides
├── core-concepts/   # Core concepts and fundamentals
├── references/      # API references and technical documentation
├── dashboard/       # Dashboard and UI documentation
├── enterprise/      # Enterprise features and administration
├── community/       # Community and contribution information
└── sidebar.json     # Navigation structure definition