Skip to content

pierrehunt/PrintFX2026

Repository files navigation

PrintFX Documentation

This folder contains architecture, implementation, API, preset, and debugging documentation for the PrintFX processing engine.

Structure

/docs
  README.md                        — This file
  /architecture                    — System design and component architecture
  /implementation                  — Setup guides and environment notes
  /api                             — API endpoint reference
  /presets                         — Preset catalog and individual preset docs
  /workers                         — Worker and job processing docs
  /audits                          — Release checklists and audit templates
  /decisions                       — Architecture decision records
  /debugging                       — Debugging guides for common issues
  /runbooks                        — Operational runbooks

Principles

  1. Documentation is part of the architecture — kept alongside code, updated when code changes
  2. Small focused files — each file covers one specific topic
  3. Audit-friendly — future reviewers and AI assistants can inspect each concern separately
  4. Every major area has: code + docs + checklist

Quick References

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors