_private/qwestly-docs/Engineering/index.md

Table of Contents

Engineering Documentation

Welcome to Qwestly's engineering documentation. This section contains all technical documentation for developers working on the Qwestly platform.

Getting Started

New Team Members

Architecture & Standards

System Architecture

  • Main applications and APIs - Candidate app, Hire app (qwestly-hire), public marketing site (public-site), and shared Python API (api-python); where Next.js APIs vs general Python APIs belong
  • Technology Stack - Detailed breakdown of our tech choices
  • AI Integration Patterns - How we implement AI throughout the platform

Development Standards

  • Code Contribution Workflow - Complete guide to contributing code, including rebase instructions
  • Git Hooks Auto-Install - Install pre-commit and other hooks automatically via npm prepare
  • Code Style Guide - TypeScript, React, and Python conventions
  • Git Workflow - Branching strategy and commit guidelines
  • Testing Strategy - Unit, integration, and E2E testing approaches
  • Security Practices - Security guidelines and best practices

Operations

CI/CD

Compliance

Component Libraries

Qwestly UI

  • Component Documentation - Shared component library
  • Design System - Design tokens and patterns
  • Usage Guidelines - How to use and extend components

AI & ML

LangChain Integration

  • Chain Patterns - Common LangChain implementation patterns
  • Provider Management - Multi-LLM provider strategy
  • Prompt Engineering - Best practices for prompt design

Document Processing

  • RAG Implementation - Retrieval-Augmented Generation setup
  • PDF Processing - Document extraction and parsing
  • Vector Storage - Embedding management with Supabase

API Documentation

Python Backend

  • Internal and shared services in api-python - What belongs in api-python, /api/internal + QWESTLY_SERVICE_API_KEY, referrer rules, and qwestly_internal DB
  • Endpoint Documentation - API reference for Python services
  • Data Models - Pydantic models and validation
  • Error Handling - Error response patterns

Frontend APIs

  • API Routes - Next.js API route documentation
  • Client SDK - Frontend API client patterns
  • Authentication - Auth0 integration patterns

Troubleshooting

Common Issues

  • Environment Setup - Solving common development environment issues
  • Deployment Problems - Vercel deployment troubleshooting
  • Database Issues - MongoDB connection and query problems
  • AI Provider Issues - LLM API troubleshooting

Document Owner: Dominick Pham, CTO
Last Updated: July 1, 2025