Developer Documentation
Learn how MindCradle's Compounding Intelligence Engine and Memory Protocol work under the hood.
Welcome to the MindCradle Developer Portal. This documentation hub is designed to help software engineers, data scientists, and security researchers understand our underlying technologies, API integration pathways, and privacy architectures. Whether you are looking to build custom clients, run local semantic models, or verify our security claims, you will find comprehensive guides and code specifications below.
Documentation Overview
MindCradle's codebase is designed as a modular monorepo, separating frontend client views from backend logic and database structures. The documentation is divided into three key areas to help developers navigate the project easily:
- Getting Started: Basic onboarding guides, CIE overviews, and answers to common developer or user questions.
- Core Concepts: Detailed explanations of the Memory Protocol, Personal Knowledge Graph (PKG) models, and security principles.
- API & Architecture: Technical specifications of FastAPI endpoints, database schemas, and Google Cloud Run deployment topologies.
We recommend that new developers start with the [Introduction to MindCradle](/docs/introduction) to understand our design philosophy, and then review the [Memory Protocol](/docs/memory-protocol) to see how relational memory is maintained across chat sessions.
For local development setup, configuration variables, and custom schema migrations, refer to the [System Architecture](/docs/architecture) and [API Reference](/docs/api) sections. If you encounter issues, search the [Frequently Asked Questions](/docs/faq) or reach out to the development team on GitHub. All developer endpoints are protected by rate limiters to ensure performance and prevent denial-of-service issues.
We also encourage community contributions; if you find typos, outdated schemas, or want to contribute new documentation pages, please submit a Pull Request following our styling and code guidelines.
