Marsad Documentation
Product, system, and repository-specific documentation for Marsad.
Welcome to the Marsad documentation. New developers can follow the guided onboarding tutorial; returning contributors can choose the scope that matches the question they need to answer.
Product pages describe Marsad's users, capabilities, and workflows. System pages describe cross-service architecture and contracts. Repository pages document the implementation and operation of one codebase.
Tutorials
A guided path from your first checkout to a reviewed Marsad change.
Product
Users, capabilities, and user-facing workflows.
System
Cross-service architecture, contracts, and shared operations.
Web App (main/)
The Next.js web application's architecture, workflows, configuration, and contribution guidance.
Model Server (model-server/)
The Flask service's pipelines, collectors, workers, configuration, and contribution guidance.
How This Documentation Is Organized
- Put a topic in Tutorials when it teaches a task through an ordered, hands-on sequence.
- Put a topic in Product when it describes users, capabilities, or user-facing workflows.
- Put a topic in System when it describes cross-service boundaries, architecture, contracts, or operations.
- Put a topic under a repository when it explains code, internal architecture, local setup, configuration, or changes within that repository.
- Link to shared system contracts instead of copying them into repository documentation.