← Back to App

Epok Advisor Docs

Epok Advisor — Project Documentation

This folder contains the living documentation for the Epok Advisor platform, built for Epok Advice (Kendra Thompson's advisory consulting business).

Live at: https://epok-advisor.netlify.app Repo: https://github.com/bunswoDS/epok-advisor (private)

Documentation Index

  • Project Overview — What this project is, what's built, and who uses it
  • Tech Stack — Technologies, architecture, file structure, env vars, testing
  • Content Strategy — How markdown content flows through the system
  • Content Architecture — Database-first design: folders, tags, versioning, editing, AI integration, exports
  • Personas & Roles — Role hierarchy, auth (human + API), RLS strategy
  • User Flows — Engagement lifecycle, questionnaires, AI chat, analysis, KB management, exports, external API access
  • Database Schema — All 18 tables, enums, RLS policies, seed data
  • Future Ideas — What's been implemented vs. what's still planned

For AI Coding Agents

These docs are intentionally written to be useful for both humans and AI agents. If you're an agent working on this codebase:

  1. Start with project-overview.md for domain context and a summary of all features
  2. Check tech-stack.md for architectural constraints, file structure, and environment setup
  3. Read content-architecture.md for how content is stored (folders + tags, not paths), versioned, embedded, and exported
  4. Read personas-and-roles.md for the role hierarchy, auth methods (Supabase, API keys, OAuth), and RLS strategy
  5. Read database-schema.md for the full table structure before writing any queries or migrations — note: content_documents no longer has path or content_type columns
  6. Read user-flows.md for the engagement lifecycle and all implemented workflows
  7. Check future-ideas.md to see what's already built vs. what's still planned

Key gotchas for agents

  • No Hono — API routes use React Router loaders/actions, not a separate API framework
  • No path or content_type on content_documents — Use folder_id and content_document_tags instead
  • TipTap pinned to v3.20.1 — Do not upgrade (v3.20.3+ breaks Vite builds)
  • Flat file routing — Dot-delimited filenames: admin.engagements.$id.tsx → /admin/engagements/:id
  • Epok green — Accent color is epok-* (not blue), defined in tailwind.config.ts