The source of truth for docs.rushdb.com—from your first record to production graph infrastructure and durable agent memory.
Quick start · Learn RushDB · Connect tools · Deploy
This repository contains the official documentation for RushDB: a property-centric Labeled Meta Property Graph (LMPG) database and memory layer for modern applications and AI agents. It covers RushDB Cloud and self-hosting, TypeScript and Python SDKs, the REST API, MCP and agent integrations, records and relationships, structured queries, semantic search, and production operations.
| Section | What you will find |
|---|---|
| Quick start | The shortest path from an API key to storing and querying data. |
| Learn | Core graph concepts, records, relationships, SearchQuery, semantic search, agent memory, API references, and practical tutorials. |
| Connect | SDKs, REST, MCP, agent skills, and native OpenClaw and Hermes memory integrations. |
| Deploy | Docker, source and Helm installation, cloud hosting, infrastructure, configuration, security, backup, and troubleshooting. |
| RushDB Cloud | Billing, project isolation, licensing, services, and managed-versus-self-hosted guidance. |
The site includes local full-text search, responsive navigation, Mermaid diagrams, syntax-highlighted examples, reusable MDX components, raw page sources, and machine-readable documentation indexes for agents and LLM tooling.
Requirements:
- Node.js 20–26
- pnpm 10
Install the locked dependency graph and start the development server:
pnpm install --frozen-lockfile
pnpm startDocusaurus serves the site at http://localhost:3000 with live reload.
Before opening a pull request, run the high-signal checks for a production-ready site:
pnpm types:check
pnpm buildTo inspect the production output locally:
pnpm servepnpm build validates document routes, fails on broken Docusaurus links, warns on broken Markdown links, builds the local search index, copies raw documentation sources, and generates the llms*.txt files under build/.
- Add or update a
.mdor.mdxfile underdocs/. - Give the page concise
titleanddescriptionfront matter. - Register new navigation entries in
sidebars.ts; the sidebar is intentionally curated rather than autogenerated. - Use root-relative links for documentation routes, such as
/learn/semantic-search, and/img/...paths for assets understatic/img/. - When moving a published page, add its legacy URL to
redirects-migration.ts. - Run
pnpm types:checkandpnpm buildbefore submitting the change.
Prefer a focused example that readers can run over an exhaustive abstract explanation. State prerequisites before commands, keep terminology consistent with the SDKs and REST API, and distinguish RushDB Cloud behavior from self-hosted behavior whenever they differ.
| Path | Purpose |
|---|---|
docs/ |
All documentation source pages, organized by public route. |
sidebars.ts |
Curated navigation hierarchy and sidebar icons. |
static/ |
Images, favicons, social cards, and other directly served assets. |
src/components/ |
Reusable MDX and documentation UI components. |
src/theme/ |
Swizzled Docusaurus theme components and navigation behavior. |
src/css/custom.css |
RushDB documentation theme and responsive styling. |
plugins/ |
Local Docusaurus plugins for tutorials and Tailwind processing. |
redirects-migration.ts |
Redirects that preserve previously published URLs. |
docusaurus.config.ts |
Site metadata, search, redirects, raw-source export, and LLM-index generation. |
Generated directories—build/ and .docusaurus/—are intentionally ignored and should not be edited or committed.
The site is configured for https://docs.rushdb.com at the root path. A production build writes the deployable static site to build/, including:
- HTML, assets, sitemap, and the local search index;
- original page sources under
build/raw-docs/; llms.txtand section-specific compact indexes;llms-full.txtand section-specific full-content bundles.
Publish the contents of build/ with the static hosting platform used for docs.rushdb.com.
- RushDB — database, platform, TypeScript SDK, MCP server, and deployment templates
- RushDB Python — Python SDK
- RushDB OpenClaw Memory — native OpenClaw memory integration
- RushDB Hermes Memory — native Hermes Agent memory provider
Apache-2.0. See LICENSE.