LeadDB Documentation

Documentation lives in the repository under the `docs/` directory. Browse by topic below and open the referenced markdown files in your editor or GitHub viewer. Each document lists its intended audience and links to related material.

Overview

Start here for the product story and high-level architecture.

  • System Overview(docs/overview/system-overview.md)
  • Architecture Overview(docs/development/architecture-overview.md)

Development

Local setup, coding standards, commands, and active migrations.

  • Local Setup(docs/development/local-setup.md)
  • Command Reference(docs/development/command-reference.md)
  • Code Structure & Conventions(docs/development/code-structure.md)
  • TypeScript Migration Guide(docs/development/typescript-migration-guide.md)
  • Data Flow(docs/development/data-flow.md)
  • Environment Configuration(docs/development/environment.md)

Operations

Deployment and database maintenance procedures.

  • Deployment Guide(docs/operations/deployment.md)
  • Database Migrations(docs/operations/database-migrations.md)

Integrations

External system connectors and sync workflows.

  • HubSpot Integration(docs/integrations/hubspot.md)

AI Agents

Guardrails and quick facts for autonomous coding assistants.

  • Repository Briefing(docs/ai-agents/repo-briefing.md)

History & Context

Archived plans and retrospectives for major initiatives.

  • Code Quality Improvements(docs/history/code-quality-improvements.md)
  • TypeScript Migration History(docs/history/typescript-migration.md)
  • Product Intelligence Upgrade(docs/history/product-intelligence-upgrade.md)
  • Archive (legacy docs)(docs/history/archive/)

How to Contribute

  • Keep documentation inside the `docs/` hierarchy using the structure defined in `docs/README.md`.
  • Add audience notes and cross-links when creating new guides.
  • Open pull requests for doc updates; request review before merging.
  • Move superseded documents to `docs/history/archive/` with a clear note.