Documentation overview

1. Purpose

This folder contains (should contain) all technical and client-facing documentation for the project. The goal is to keep the documentation consistent and easy to navigate, across all subteams.

2. Structure

File / Folder	Description
overview.md	You are here — index of all documentation files.
architecture.md	System design, data flow, and integration between backend, data, and UI
backend.md	Backend API endpoints, database connection details
ui_visualization.md	Frontend/dashboard structure, visualization logic, and dependencies.
client/	Client-facing documentation: user manual, demo guide etc.
sprint_summaries/	Sprint-by-sprint summaries and notes.

3. Documentation Guidelines

To keep documentation consistent and easy to navigate, every subteam should:

1. Update documentation alongside code changes.
2. When you finish a new feature, update the relevant .md file in this folder.
3. Follow consistent formatting.
4. Use clear section headers (##), bullet points, and short paragraphs.
5. Avoid duplication.
6. Link to other files instead of rewriting the same content. Example:
   See architecture.md