Welcome to the official documentation for DocumentDB.

Documentation Sections

• Getting Started - Quick start guides and basic concepts
• API Reference - Detailed API documentation
• PostgreSQL API - PostgreSQL-compatible API documentation
• Architecture - System architecture and design principles
• documentdb-local - Detailed documentation of the documentdb-local container image
• DocumentDB Kubernetes Operator - Documentation for the DocumentDB Kubernetes Operator

Contributing

When contributing to this documentation repository, keep the following in mind:

API Reference Pages

Landing pages for the api-reference folder are dynamically generated. There's no need to add index.md files or manually maintain lists of reference articles.

To customize the documentation:

• Landing page descriptions: Update the _metadata.description.md file in each folder to change the description shown on the landing page.
• Metadata: Modify the YAML front matter in each article to update metadata (SEO, category, type, etc.) for individual pages.