Official documentation for the ResQ autonomous disaster-response platform — built with Mintlify, MDX, and auto-generated API references from OpenAPI specs.
| Section | Description |
|---|---|
| Getting Started | Introduction, quickstart, and local dev setup |
| AI Tools | Integration guides for Cursor, Claude Code, and Windsurf |
| API Reference — Infrastructure | Incidents, evidence, blockchain events, Solana delivery/airspace endpoints |
| API Reference — Coordination HCE | Fleet management, mission dispatch, telemetry, WebSocket, and admin endpoints |
API references are auto-generated from OpenAPI specs in specs/infrastructure.json and specs/coordination.json.
Prerequisites: Node.js v19+
# Install the Mintlify CLI
npm i -g mint
# Clone the repo
git clone https://github.com/resq-software/docs.git
cd docs
# Start the local preview server
mint devOpen http://localhost:3000. Changes to .mdx files hot-reload instantly.
Pages are .mdx files with YAML frontmatter:
---
title: 'Your Page Title'
description: 'One-line description shown in search and cards'
---
Content goes here. Full MDX syntax supported — import React components, use Mintlify's built-in `<Card>`, `<Tabs>`, `<CodeGroup>`, etc.Navigation is controlled by docs.json. Add a new page by creating the .mdx file and adding its path to the appropriate group in navigation.tabs:
{
"group": "Getting started",
"pages": ["index", "quickstart", "development", "your-new-page"]
}API reference pages point to an OpenAPI spec:
---
title: My Service API
openapi: ../specs/my-service.json
---Drop new OpenAPI specs in specs/ and reference them the same way.
# Check for broken links before pushing
mint broken-linksPush to main — the Mintlify GitHub App triggers a build and deploys to the production CDN automatically. No manual steps required.
| Problem | Fix |
|---|---|
| Preview won't start | Delete ~/.mintlify cache and re-run mint dev |
sharp module errors |
Ensure Node v19+ and reinstall the CLI |
| Broken links in CI | Run mint broken-links locally first |
- Fork and create a branch:
docs/your-topic - Preview changes locally:
mint dev - Check for broken links:
mint broken-links - Open a PR — describe what changed and why
Write in active voice. Keep sentences short. If documenting an API, verify the endpoint behavior against the actual service before publishing.
Copyright 2026 ResQ. Licensed under the Apache License, Version 2.0.