Welcome to the Diff Voyager documentation. This guide will help you navigate through the project's architecture, development status, and implementation details.
- Getting Started Guide - Installation, setup, and first steps
- Development Workflow - TDD approach, commit guidelines, and best practices
- Architecture Overview - High-level system design and monorepo structure
- Domain Model - Core entities and their relationships
- Technology Stack - Technologies used across all packages
- Status - Current status, completed work, and known issues
- Goals - Short-term, medium-term, and long-term goals
- API Endpoints - Complete REST API specification
- Types and Schemas - TypeScript interfaces and request/response types
- Crawler - Page capture, browser management, and site crawling
- Comparators - SEO, visual, header, and performance comparison
- Task Queue - Asynchronous task processing and retry logic
Development:
- Testing Strategy - TDD approach, test structure, and coverage
- Backend Development - Backend workflows, test commands, and patterns
- Frontend Development - Vue 3 development, common issues, and screenshots
- Running Servers - Server configuration and API testing
Technical Guides:
- Security Guidelines - Security best practices and requirements
- @ts-rest Guide - Type-safe API contract patterns
- Drizzle ORM Guide - Database query patterns with Drizzle
- i18n Guide - Internationalization with Vue I18n
Project Management:
- Issue Management - Issue hierarchy and dependency tracking
- Common Regression Points - Known fragile areas and prevention strategies
docs/
├── README.md (this file)
├── architecture/
│ ├── overview.md
│ ├── domain-model.md
│ └── technology-stack.md
├── development/
│ ├── status.md
│ ├── goals.md
│ └── changelog.md
├── api/
│ ├── endpoints.md
│ └── types.md
├── guides/
│ ├── getting-started.md
│ ├── development-workflow.md
│ ├── testing-strategy.md
│ ├── backend-dev.md
│ ├── frontend-dev.md
│ ├── running-servers.md
│ ├── security.md
│ ├── ts-rest.md
│ ├── drizzle-orm.md
│ ├── i18n.md
│ ├── issue-management.md
│ └── common-regressions.md
├── features/
│ ├── crawler.md
│ ├── comparators.md
│ └── task-queue.md
└── screenshots/
└── README.md
- Main README - Project overview and quick start
- CLAUDE.md - Development guide for AI-assisted coding
- PRD - Complete product requirements document
See Development Workflow for contribution guidelines and best practices.