Forma3D.Connect Documentation¶

Integration platform bridging Shopify e-commerce with SimplyPrint 3D print farm management

This folder contains all project documentation organized by category.

Documentation Structure¶

Quick Links¶

Business & Product¶

• Vision Document - Project vision, objectives, and success criteria
• Requirements - Functional and non-functional requirements

User Manual¶

• Web App User Manual - How to use Forma3D.Connect (Admin Dashboard)

Strategy & Planning¶

• Strategy Overview - Strategic planning documentation
• Enterprise Architecture - ArchiMate diagrams
• Roadmap - Project timeline and milestones

Technical Architecture¶

• Architecture Overview - C4 model and technical decisions
• Architecture Decision Records - All ADRs
• C4 Diagrams - Context, Container, Component, Code diagrams
• Sequence Diagrams - System flow diagrams
• State Machines - Entity lifecycle diagrams

Development & Deployment¶

• Implementation Plan - Development phases (Phases 0-6 Complete)
• Trunk-Based Development - Git workflow
• Staging Deployment Guide - Deployment process
• Cosign Setup Guide - Container signing

Marketing¶

• Marketing Overview - Launch and marketing strategy

Technology Guides¶

• React Crash Course - Get up to speed with React for this project
• NestJS Crash Course - Get up to speed with NestJS for this project

Diagram Rendering¶

Most diagrams in this documentation use PlantUML. To render them:

VS Code (Recommended)¶

1. Install the PlantUML extension
2. Open any .puml file
3. Press Alt+D to preview

Command Line¶

# Install PlantUML (macOS)
brew install plantuml

# Render all diagrams
find docs -name "*.puml" -exec plantuml {} \;

# Render as SVG
find docs -name "*.puml" -exec plantuml -tsvg {} \;

Online¶

Copy any .puml file contents to PlantUML Web Server

Contributing¶

When updating documentation:

1. Keep cross-references updated - Check links when moving files
2. Follow naming conventions - Use lowercase kebab-case for new files
3. Add to indexes - Update README files when adding new documents
4. Update ADRs - Document significant architectural decisions

Document Standards¶

• Markdown for text documents
• PlantUML for diagrams (C4, ArchiMate, sequences, state machines)
• Kebab-case for file names (e.g., staging-deployment-guide.md)
• Numbered prefixes for ordered sections (e.g., 01-business/, 02-strategy/)

Forma3D.Connect | Documentation Index