Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/estebanrfp/gdb/llms.txt

Use this file to discover all available pages before exploring further.

GenosDB Documentation

Welcome to the official technical documentation for GenosDB.

API Reference & Advanced Documentation


  • πŸ› οΈ CRUD Operation Guide (Overview of CRUD APIs with links to detailed guides)
  • πŸ“€ PUT Guide (Insert/update nodes; auto ID, persistence, and events)
  • πŸ“₯ GET Guide (Retrieve nodes by ID; optional real-time subscription)
  • πŸ—ΊοΈ MAP Guide (Query language, real-time subscriptions, and $edge traversal)
  • πŸ—‘οΈ REMOVE Guide (Delete nodes and clean up edges; persistence and notifications)
  • πŸ”— LINK Guide (Create directed relationships between nodes)

API Reference (Modules)

  • πŸ” Security Manager (SM API Reference) (RBAC, identity (WebAuthn/mnemonic), signing/verification)
  • πŸ“‘ GenosRTC API Reference (P2P WebRTC API: rooms, data channels, audio/video)
  • πŸ›°οΈ Own signaling relay: built into the Fallback Server (--relay β€” one flag, zero extra infrastructure)
  • βš™οΈ GenosRTC Architecture (A technical breakdown of GenosDB’s GenosRTC Module architecture, explaining its key components, including the decentralized signaling layer with Nostr, the P2P transport layer with WebRTC, and the communication abstractions for data and media.)
  • πŸ”· GenosRTC Cells (Cellular mesh overlay: architecture, bridges, TTL, metrics, and scalability)


  • βš™οΈ GenosDB Worker Architecture (Technical overview of the persistence worker, covering its tiered storage strategy and data integrity mechanisms.)
  • πŸ”„ GenosDB Hybrid Delta Protocol (Details the dual-mode engine ensuring real-time speed via delta updates and reliability via a full-state fallback.)
  • πŸ•°οΈ GenosDB Hybrid Logical Clock (HLC) (An advanced timestamping system that blends physical time with a logical counter to ensure causal event ordering and enable robust, deterministic conflict resolution.)
  • 🧯 GenosDB Fallback Server (Optional superpeer Node.js service to improve availability)
  • πŸ“¦ Bundler Configuration (Vite, Webpack, Bun, esbuild, and CDN usage)

Roadmap & Whitepaper

  • 🧭 ROADMAP.md (Planned features and milestones)
  • πŸ“„ WHITEPAPER.md (Architecture and design paper)
  • πŸ“œ PHILOSOPHY.md (Project philosophy, founder history, and coreprinciples)

Root Documentation

  • 🏠 README.md (Project overview, installation, and docs)
  • 🧾 CHANGELOG.md (Release notes and version history)
  • 🀝 CONTRIBUTING.md (How to contribute examples and guidelines)
  • πŸ”€ MIGRATION.md (Migrate from β€œnew GDB()” to β€œawait gdb(…)”)
  • πŸ›‘οΈ SECURITY.md (Security policy and vulnerability reporting)
  • βš–οΈ THIRD_PARTY_LICENSES (Third-party and project licenses)

Build docs developers (and LLMs) love