Documentation Structure & Navigation Guide

Last Updated: 2026-05-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
• First-time setup? See the Complete Setup Guide — Notion, Slack, Symfony, env vars
• Daily development? See Implementation Guide
• Understanding the architecture? Read Layered Architecture

Project Planning

• MVP Scope — What was delivered in the MVP
• MVP User Stories — 30 delivered user stories
• MVP Roadmap — Completed development timeline
• POC Scope — POC achievements and deliverables
• POC Implementation — Step-by-step Input → Process → Output walkthrough
• Deferred Features — Features planned but not built

Technical Documentation

Backend

• Database Schema — Tables, entities, ER diagram
• Entities — Entity reference and relationships
• Services — Service directory
• API Reference — REST endpoints
• AI Summary System — Hardcoded prompt, lazy generation
• Layered Architecture — 10-layer architecture reference
• Architecture Flows — Flow-by-flow system walkthrough

Slack & Integrations

• Slack User Guide — End-user instructions
• Slack Handlers — Technical handler reference
• Notion Integration — Sync architecture

Testing

• Testing Overview — PHPUnit + Jest + Playwright strategy

Workflow & Reports

• E2E Flow — Complete system flow diagram
• Internship Report — Stagerapport (Dutch)
• Weekly Reports — Week-by-week logs

Documentation Map

docs/
├── index.md                    # Landing page
├── setup/
│   └── guide.md                # Canonical setup (Notion, Slack, backend, env)
├── development/
│   ├── implementation-guide.md # Daily dev commands
│   └── documentation-guide.md
├── architecture/
│   ├── layered.md              # 10-layer architecture reference
│   ├── flows.md                # Architecture flow walkthrough
│   └── slack-bot.md            # Slack bot system design
├── operations/
│   └── notion-sync-deployment.md
├── project/                    # Scope, backlog, git strategy
├── poc/                        # POC step-by-step implementation
├── mvp-presentation/           # MVP feature walkthroughs with demos
├── backend/                    # Backend technical docs
├── workflow/                   # User stories, roadmap, E2E flow
├── tests/                      # Testing documentation
├── integrations/               # Notion hub
├── slack/                      # Slack bot docs
├── report/                     # Internship report (+ build scripts)
├── weekly/                     # Weekly progress logs
└── public/                     # Static assets, logos, demo videos

URL redirects

Legacy bookmark URLs are handled by docs/public/_redirects (deployed with Cloudflare Pages). Examples:

Old URL	New URL
/notion-import-guide	/setup/guide
/ArchitectureLayered	/architecture/layered
/IMPLEMENTATION_GUIDE	/development/implementation-guide
/deployment	/operations/notion-sync-deployment