Pathfinder Docs

Documentation Preview

Documentation Index

Source: `docs/INDEX.md`View on GitHub

Documentation Index

Welcome to the CRM internal documentation. This index reflects the reorganized structure (architecture, project, product, data, integrations, security, operations). Documentation should match the current implementation; unverified content is marked with TODO.

Help and end-user documentation live in app/help/ and are separate from this tree.


Start here

  • Product & Technical Context — one-document orientation: what Pathfinder is, who uses it, roles/tiers/modules, the domain model, the stack and access-control layers, the module build recipe, and current tech debt.

Structure

Architecture

System design and technical structure: auth flow, middleware, module boundaries.

Project

What the CRM is, who it’s for, and how it’s managed.

Product

Features and module-level behavior: clients, intake, resources, referrals, reports, documents, inventory, corps, landlord portal, rangefinder.

  • README
  • Product-level docs — INTAKE_EDIT_FEATURE, INTAKE_VERSIONS, TARGETED_SECTION_EDITING, RANGEFINDER_MVP_SUMMARY, RENTAL_HEATMAP_REPORT
  • Features — Admin dashboard, affordability, intake, archive/audit, clients, resources, referrals, pagination, properties/contacts, units, rental heatmap, milestones, organization modules, document vault, inventory, tasks/activities/reminders, insights page, etc.
  • Landlord Portal
  • Corps (API spec, README)

Data

Data and schema: entities, reporting sources, migrations.

Integrations

Third-party and external systems: Azure sync, Cosmos DB, HUD/rental heatmap.

Security

Access control, roles, permissions, audit.

Operations

Local setup, environment, deployment, troubleshooting, testing.

Help Desk

Operator-facing guidance for support and frontline teams.

  • README
  • Module guides — CRM core, clients/intake, resources/referrals, reports/insights, documents, inventory, corps, landlord portal

Quick links

GoalDoc
First-time setupQuick StartSupabase Setup
What this CRM isProject Overview
Routes and rolesAccess Control
Modules and tiersOrganization Modules
Insights pageInsights Page
Search analyticsSearch Events Table
Azure syncIntegrations
Landlord portalProduct: Landlord Portal
TroubleshootingOperations

Classification (optional)

Documents can be tagged as:

  • source-of-truth — Authoritative; keep in sync with code.
  • derived-from-code — Written from current implementation; verify when code changes.
  • conceptual / forward-looking — Design or roadmap; may not match current behavior.

When in doubt, prefer derived-from-code and add a “Last verified against code: YYYY-MM-DD” note.


Use links in each imported doc to open its source.