HydraDB Documentation

Public-facing documentation for HydraDB, built with Mintlify. The site is authored in MDX and configured via docs.json.

Live site: https://docs.hydradb.com

---

Prerequisites

Tool	Version	Install
Node.js	18+	nvm install 18 or download from nodejs.org
pnpm	latest	npm install -g pnpm

Quick Start

git clone https://github.com/hydra-db/mintlify-docs.git
cd mintlify-docs
make bootstrap   # installs dependencies
make dev         # starts local dev server at http://localhost:3000

Available Make Targets

Target	Description
make help	Show all available targets
make bootstrap	Zero-to-running setup (install deps, print next steps)
make install	Install dependencies with pnpm
make dev	Start Mintlify dev server (http://localhost:3000)
make build	Validate the documentation build
make clean	Remove node_modules/ and .mintlify/ cache

Documentation regression checks

CI checks the docs against the public v2 contract: endpoint bindings, JSON examples, canonical names, and the agent guide's endpoint mentions. It runs without real vendor calls or credentials.

python -m venv .venv
. .venv/bin/activate
python -m pip install -r scripts/requirements-test.txt jsonschema==4.25.1
python -m unittest discover -s scripts -p 'test_*.py'
python .github/verify_v2_public_contract.py
python -m unittest discover -s .github -p 'test_v2_schema_types.py'
python scripts/verify_agents_endpoints.py
python scripts/generate_llms_index.py --check
pnpm mintlify validate

When adding or removing a documentation page, regenerate the complete agent index with python scripts/generate_llms_index.py. Mintlify serves the root llms.txt; llms-full.txt remains Mintlify-generated. These local contract tests don't prove live indexing or authenticated vendor workflows.

Content Structure

mintlify-docs/
├── docs.json                  # Mintlify config (navigation, theme, logos)
├── index.mdx                  # Home / landing page
├── concepts.mdx               # Core concepts overview
├── quickstart.mdx             # Getting started guide
├── essentials/                 # Essential guides
│   ├── recall.mdx             #   Recall functionality
│   ├── memories.mdx           #   Working with memories
│   ├── context-graph.mdx      #   Context graph
│   ├── multi-tenant.mdx       #   Multi-tenancy
│   ├── metadata.mdx           #   Metadata handling
│   └── use-api-results.mdx    #   Using API results
├── plugins/                   # Plugin integrations
│   ├── claude-code.mdx        #   Claude Code plugin
│   ├── open-claw.mdx          #   OpenClaw plugin
│   └── mcp.mdx                #   MCP integration
├── use-cases/                 # Example use cases
│   ├── glean-clone.mdx        #   Glean clone
│   ├── ai-chief-of-staff.mdx  #   AI Chief of Staff
│   ├── ai-linkedin-recruiter.mdx  # AI LinkedIn Recruiter
│   └── ai-travel-planner.mdx  #   AI Travel Planner
├── api-reference/             # API reference docs
│   ├── openapi.json           #   OpenAPI spec
│   ├── sdks.mdx               #   SDK overview
│   ├── error-responses.mdx    #   Error responses
│   └── endpoint/              #   Individual endpoint docs
├── snippets/                  # Reusable MDX snippets
├── images/                    # Image assets
├── logo/                      # Brand logos (light/dark)
├── scripts/                   # Developer scripts
│   └── bootstrap.sh           #   Project bootstrap
└── Makefile                   # Developer workflow targets

Adding & Editing Documentation

1. Edit an existing page - Open the corresponding .mdx file and modify the content. The dev server hot-reloads changes.

2. Add a new page - Create a new .mdx file in the appropriate directory, then add its path to the navigation section in docs.json.

3. Update navigation - All page ordering and grouping is controlled in docs.json under navigation.tabs.

4. API reference pages - Endpoint docs live in api-reference/endpoint/. The OpenAPI spec is at api-reference/openapi.json.

5. Reusable content - Shared snippets go in the snippets/ directory and can be imported into any page.

Useful Links

• Mintlify Documentation
• MDX Syntax Guide
• Mintlify Components
• HydraDB Website