Use this page as the navigation entry point for current PrintFarmer documentation. Historical implementation notes that no longer describe the repository are intentionally omitted.
- README - Project overview and quick start
- Getting Started - Local setup
- Development Guide - Code style, tests, local development, and contribution workflow
- Architecture - System components and data flow
- Architecture Flows - Detailed request and service interactions
- Module Migration Pattern - Step-by-step
playbook for extracting a
Farm.Modules.*vertical-slice assembly out ofFarm.Web.Api, worked through theFarm.Modules.SmartPlugpilot (#2036) - Features - User-facing feature overview
- Troubleshooting - Common problems and remedies
- API Documentation - REST and SignalR overview
- API Reference - Endpoint reference
- API Documentation Guide - Maintaining API documentation
- DTO Reference - Shared data-transfer contracts
- CSV Import Format - Printer CSV schema and examples
- G-code Harvesting API - Harvesting endpoints
- Obico ML API - Obico integration contract
- Deployment Guide - Local and hosted deployment options
- Deployment Quick Reference - Common deployment commands
- Docker Deployment - Complete Docker guide
- Docker Teardown - Safe deployment removal
- Microservices Deployment - Multi-service topology
- Ubuntu Quickstart - Ubuntu host setup
- Deployment Hardware - Capacity guidance
- Local Docker Registry - Private registry setup
- pgAdmin Setup - PostgreSQL administration
- Release Guide - Release process
- iOS Beta Release Checklist - APNs/signing readiness gate and rollback controls for the operator-first iOS beta
- Licensing And Source - Corresponding source, SBOM, and provenance requirements
- OrcaSlicer Integration - Architecture, profiles, pipeline, and diagnostics
- Slicer Configuration - Slicer client setup
- Slicer Runtime Settings - Runtime settings
- Slicer Service Metrics - Monitoring
- Slicer Worker API Keys - Worker authentication
- Slicer Worker CI Security - CI safeguards
- Worker Authentication - Worker trust model
- Worker Sandboxing - Runtime isolation
- AppImage Preseed - Preseed asset production
- AppImage Uploader Runbook - Publishing preseed assets
- Auto Dispatch - Dispatch modes and scoring
- Job Queue Architecture - Queue services and workflows
- Job State Machine - Job lifecycle
- Tagging System - Polymorphic tagging
- Controls Guide - Printer controls
- Discovery Troubleshooting - Printer discovery diagnostics
- Settings Architecture - Canonical admin and settings surface architecture
- Operator Feature Gates - Feature availability
- Operator Native Push - Native push setup
- Offline Write Replay - Offline mutation replay
- Permission Model - Resource:action permissions,
the
adminimplication, deny precedence, thefarm_adminbypass, and how to add a new enforced permission - Role Permission Precedence - Grant/deny
precedence rule for
RolePermission.Granted
- UI Overview - Frontend pages and component architecture
- Design System - Tokens, themes, components, and accessibility
- Frontend UI Components - Component reference
- UI Styling Index - Styling navigation
- UI Reorganization Requirements
- Historical design requirements
- Settings Redesign V2 - Historical settings design proposal
- CI - Affected-test selection and required checks
- Contract Drift Gate - Wire-contract corpus drift check and reviewed exception allowlist
- Testing Guidelines - Deployment script test guidance
- Testing Patterns - Reusable backend test patterns
- Test Documentation Index - Test documentation navigation and documentation-health commands
- Deployment Testing - Deployment test suites
- Deployment Testing Checklist - Required validation for deployment changes
- Error Recovery - Recovery and resilience validation