Documentation Structure & Navigation Guide

Last Updated: 2026-02-27

This guide explains the documentation structure and helps you find what you need quickly.

Quick Navigation

🎯 Getting Started

• New to the project? Start with Project Overview
• Setting up? See Setup Guide and Slack App Setup
• Want to understand the architecture? Read Architecture

🚀 Current Sprint Work

• Sprint Status: MVP Roadmap - Currently Week 3, Sprint 1 MVP
• AI Summary Feature: Quick Start Guide
• Implementation Plan: AI Summary Implementation Plan
• Jira Tickets: Live Dashboard

📚 Core Documentation

Project Planning & Strategy

• Vision & Overview - Consolidated product vision and requirements
• MVP Roadmap - Detailed 12-week timeline
• MVP Scope & Requirements - 31 user stories, 8-week plan
• POC Scope & Achievements - What was built in POC
• Backlog - Full backlog (252 tickets)
• Sprints - Sprint planning (6 sprints)

Technical Documentation

• Architecture - System architecture overview
• Implementation Guide - Detailed implementation guide
• POC Guide - POC documentation
• Slack Bot Architecture - Slack bot technical details

Backend (Symfony)

• Backend Overview - Start here for backend
• API Reference - Complete REST API documentation
• Entities - Database entities
• Services - Business logic services
• Database - Database setup and management

AI Summary System (NEW)

• Architecture - Complete technical architecture
• Implementation Roadmap - 29 tickets, 3 sprints
• Quick Start Guide - Get started immediately
• Implementation Plan - Executive summary

Slack Bot

• Slack Bot Overview - Start here for Slack bot
• User Guide - How to use the bot
• Technical Docs - Handler documentation

Integrations

• Notion Integration - Notion API integration
• Notion Setup - Setup guide
• Notion API Examples - API examples

Operations

• Setup Guide - Environment setup
• Deployment - Deployment guide
• Testing - Testing guide

Development Workflow

• Git Strategy - Complete git workflow, commits, PRs, and branches
• Project Structure - File organization

Documentation Structure

Root Level (/docs/)

High-level overview documents:

• index.md - Homepage
• architecture.md - System architecture
• deployment.md - Deployment guide
• IMPLEMENTATION_GUIDE.md - Implementation guide (1022 lines)
• poc-guide.md - POC guide
• slack-bot-architecture.md - Slack bot architecture

Project (/docs/project/)

Project planning and management:

• overview.md - Vision, Success Metrics, and Project context (Consolidated)
• poc-scope.md - POC scope and achievements
• mvp-scope.md - MVP scope (31 user stories)
• backlog.md - Full backlog (252 tickets)
• sprints.md - Sprint planning
• project_structure.md - File organization
• git-strategy.md - Git workflow, commits, PRs, branches
• ai-summary-implementation-plan.md - AI summary plan (Removed)
• ai-summary-quick-start.md - AI summary quick start (Removed)

Backend (/docs/backend/)

Backend technical documentation:

Root Files:

• architecture/overview.md - Technology stack & Quick Start (Consolidated)
• api-reference.md - Complete API reference (892 lines)
• entities.md - All entities (760 lines)
• services.md - All services (688 lines)
• controllers.md - Controllers
• database.md - Database setup (814 lines)
• ai-summary.md - AI summary architecture (NEW)

Subdirectories:

• api/ - API endpoint details (4 files)
• entities/ - Entity details (2 files)
• services/ - Service details (4 files)
• architecture/ - Architecture docs (2 files)
• infrastructure/ - Infrastructure docs (2 files)
• guides/ - Guides (1 file)

Slack (/docs/slack/)

Slack bot documentation:

• README.md - Overview
• slack-bot-guide.md - User guide
• slack-handlers.md - Technical docs

Integrations (/docs/integrations/)

Integration guides:

• README.md - Overview
• notion-integration.md - Notion integration (592 lines)
• notion-setup.md - Notion setup (573 lines)
• notion-api.md - API examples

Setup (/docs/setup/)

Setup guides:

• setup.md - Environment setup
• slack-app-setup.md - Slack app setup

Tests (/docs/tests/)

Testing documentation:

• testing.md - Testing guide

Workflow (/docs/workflow/)

Workflow documentation:

• index.md - Overview
• sprint-0.md - Sprint 0 showcase
• mvp-roadmap.md - MVP roadmap
• user-stories.md - User stories

Jira (/docs/jira/)

Jira integration:

• index.md - Live dashboard links (no static files)

Weekly (/docs/weekly/)

Weekly reports:

• index.md - Dynamic index
• week-01.md through week-12.md - Weekly reports
• weekly.data.js - Data loader

Sprints (/docs/sprints/)

Sprint documentation:

• index.md - Sprint overview

Report (/docs/report/)

Internship report:

• index.md - Stagerapport

Archive (/docs/archive/)

Archived documentation:

• notion/ - Old Notion docs
• Yappa/ - Company info

Documentation Principles

1. Single Source of Truth

• overview.md is the authoritative project vision and strategy document
• mvp-roadmap.md is the authoritative timeline
• mvp-scope.md is the authoritative MVP scope
• backlog.md is the authoritative ticket list

2. Layered Documentation

• Root files provide comprehensive overviews
• Subdirectory files provide focused details
• This is intentional, not duplication

3. Living Documentation

• All docs include lastUpdated frontmatter
• Docs are updated as the project evolves
• Old versions are archived, not deleted

4. VitePress Structure

• Uses VitePress for static site generation
• Navigation defined in .vitepress/config.js
• Supports Mermaid diagrams
• Dead link checking enabled

Finding What You Need

I want to...

Understand the project → Start with Project Overview

Set up my environment → Follow Setup Guide

Understand the architecture → Read Architecture and Backend Overview

Work on AI summaries → Read AI Summary Quick Start

Create Jira tickets → Use Implementation Roadmap

Write good commits → Follow Git Strategy

Understand the API → Check API Reference

Deploy the application → Follow Deployment Guide

Test the application → See Testing Guide

Integrate with Notion → Read Notion Integration

Use the Slack bot → Check Slack Bot Guide

Recent Updates (2026-02-27)

New Documentation

• ✅ AI Summary Architecture (backend/ai-summary-architecture.md)
• ✅ AI Summary Implementation Roadmap (backend/ai-summary-implementation-roadmap.md)
• ✅ AI Summary Quick Start Guide (project/ai-summary-quick-start.md)
• ✅ AI Summary Implementation Plan (project/ai-summary-implementation-plan.md)
• ✅ Git Strategy (project/git-strategy.md) - Merged from git-workflow.md and git-commit-strategy.md
• ✅ Documentation Guide (DOCUMENTATION_GUIDE.md)

Updated Documentation

• ✅ Project Structure (project/project_structure.md)
• ✅ VitePress Config (.vitepress/config.js) - Removed dead links, merged duplicates

Fixed Issues

• ✅ Removed 23 dead links from navigation
• ✅ Merged duplicate git documentation files (git-workflow.md + git-commit-strategy.md → git-strategy.md)
• ✅ Added AI Summary section to backend docs
• ✅ Updated project structure to reflect current state
• ✅ Clarified Jira uses live dashboards (no static files)

Contributing to Documentation

When to Update Docs

• When adding new features
• When changing architecture
• When fixing bugs that affect behavior
• When learning something non-obvious

How to Update Docs

1. Update the relevant markdown file
2. Update lastUpdated frontmatter
3. Update navigation in .vitepress/config.js if needed
4. Test locally with npm run docs:dev
5. Commit with descriptive message

Documentation Standards

• Use clear, concise language
• Include code examples where helpful
• Use Mermaid for diagrams
• Add frontmatter metadata
• Link to related docs
• Keep docs up to date

Need Help?

Documentation Issues

• Check this guide first
• Search existing docs
• Check the navigation sidebar
• Look in related sections

Technical Issues

• Check Setup Guide
• Check Testing Guide
• Check Deployment Guide
• Check relevant technical docs

Project Questions

• Check Vision & Overview
• Check MVP Roadmap
• Check MVP Scope
• Check Backlog

---

Maintained by: Development Team Last Updated: 2026-02-27 Version: 1.0