Skip to main content

Getting Started


Documentation Structure

Business HQ

Strategic planning and business operations documentation.
  • Purpose & Vision - Mission statement, core values, and strategic objectives
  • Business Model - Revenue streams, pricing strategy, and market positioning
  • Team & Culture - Company culture, values, and organizational structure
  • Market Research - Market analysis, TAM/SAM/SOM, and opportunity assessment
  • User Research - User personas, pain points, and validation studies
  • Competitive Analysis - Competitor landscape and positioning
  • Go-to-Market - Launch strategy and customer acquisition
  • Roadmap - Business milestones and strategic timeline
  • Business Metrics - KPIs, growth metrics, and performance tracking
  • Customer Success - Support processes and retention strategies
  • Partnerships - Strategic partnerships and integration opportunities
  • Legal & Compliance - Regulatory requirements and legal framework

Engineering

Technical architecture, development practices, and API documentation.
  • Overview - System architecture and technical principles
  • System Design - Microservices design and integration patterns
  • Data Architecture - Database design and data flow
  • Security Architecture - Security patterns and compliance
  • Service Catalog - Complete overview of our 6+ microservices
  • Authentication - Identity management and authorization
  • Animal Management - Animal records and ownership tracking
  • Pedigree Engine - Lineage tracking and visualization
  • Media Service - File upload and image processing
  • Getting Started - Development environment setup
  • Coding Standards - Style guides and best practices
  • Testing Strategy - Test coverage and quality assurance
  • Deployment - CI/CD pipelines and release process

Product

Product strategy, feature specifications, and design guidelines.
  • Product Vision - Product goals and success metrics
  • Feature Prioritization - Roadmap and priority framework
  • User Personas - Target users and use cases
  • User Journeys - Experience mapping and user flows
  • Pedigree Tracking - Core lineage functionality
  • Breeder Profiles - Public profiles and verification
  • Animal Records - Comprehensive animal database
  • Breeding Management - Pairing and clutch tracking
  • Marketplace - Animal listings and transactions

Operations

Monitoring, deployment, incident management, and security procedures.
  • Telemetry Overview - Centralized observability with repti-telemetry
  • Service Health - Health monitoring and SLA tracking
  • Performance Metrics - Key performance indicators
  • Alerting - Alert configuration and escalation
  • Deployment Strategy - Blue-green and canary deployments
  • Release Process - Release management and approval workflows
  • Environment Management - Development, staging, and production
  • Rollback Procedures - Incident response and recovery

Quick Access


External Resources


Key Metrics

Platform Scale: 6+ microservices • 4 core domains • Multi-tenant architectureTech Stack: FastAPI • Next.js • PostgreSQL • Redis • AWS • DockerObservability: Centralized telemetry • CloudWatch integration • Real-time monitoring

This documentation is actively maintained and updated with each release. For the most current information, check the last updated date on individual pages.