Skip to content

docs: architecture diagrams + comprehensive API/AI/database documentation - #32

Merged
Alaashamel merged 1 commit into
mainfrom
docs/architecture-and-api
Aug 20, 2026
Merged

Alaashamel merged 1 commit into
mainfrom
docs/architecture-and-api

Conversation

@Alaashamel

Copy link
Copy Markdown
Owner

Summary

Comprehensive architecture diagrams and API/AI/database documentation — 1,636 lines of new docs.

Architecture Diagrams (docs/architecture/diagrams.md)
8 Mermaid diagrams rendering in GitHub's markdown viewer:

  • System architecture (5-service Docker Compose topology)
  • Request lifecycle (sequence diagram: browser → nginx → API → DB)
  • Authentication & authorization flow (registration → login → refresh)
  • RBAC permission matrix (5 roles × 9 permissions)
  • AI pipeline flow (job intent → ingestion → model → validation → result)
  • Real-time Socket.io architecture (rooms, events, presence)
  • Data model ERD (29 tables, all relationships)
  • Deployment topology (load balancer, scaling, external services)

API Reference (docs/api/README.md)
Complete endpoint documentation for all 85 HTTP endpoints + 6 Socket.io events:

  • Authentication (register, login, refresh, logout, verify, password reset)
  • Organizations, projects, milestones, labels (CRUD + RBAC)
  • Tasks (CRUD, comments, labels, activity, dependencies with cycle detection)
  • GitHub OAuth + repository management (import, sync, webhooks)
  • Analytics (overview, velocity, health, developers, repositories)
  • Notifications, activity feed, chat
  • AI module (analyses, jobs, conversations, streaming assistant)
  • Real-time events (room join, presence, typing, live updates)
  • Request/response examples, error codes, pagination, filtering

AI Service Docs (docs/ai/README.md)

  • Pipeline architecture (6-stage pattern)
  • Provider gateway (OpenAI, Anthropic, Local)
  • Security model (prompt injection defense, secret redaction)
  • Repository ingestion pipeline (9 steps)
  • RAG retrieval (hybrid vector + keyword)
  • Job intent protocol (signed HMAC tokens)
  • Engineering assistant SSE streaming flow
  • Testing guide (145+ pytest tests)

Database Docs (docs/database/README.md)

  • Schema overview (29 tables, 7 domains)
  • 12 versioned migrations with changelog
  • Entity relationship diagrams
  • Seed data reference
  • Redis key patterns
  • pgvector setup (HNSW index for embeddings)
  • Performance indexes

…tation

Add 8 Mermaid architecture diagrams: system overview, request lifecycle,
authentication flow, RBAC permission matrix, AI pipeline flow, real-time
Socket.io architecture, data model ERD, and deployment topology.

Add comprehensive API reference (docs/api/README.md) covering all 85
HTTP endpoints and 6 Socket.io events across 15 modules: auth,
organizations, projects, milestones, labels, tasks, GitHub OAuth,
repositories, analytics, notifications, activity, chat, AI, and
real-time. Includes request/response examples, error codes, pagination,
and permission matrix.

Add AI service documentation (docs/ai/README.md) covering pipeline
architecture, provider gateway, security model (prompt injection
defense, secret redaction), ingestion pipeline, RAG retrieval, job
intent protocol, engineering assistant SSE flow, and testing guide.

Add database documentation (docs/database/README.md) covering schema
overview, 12 migrations, entity relationships, seed data, Redis keys,
pgvector setup, and performance indexes.
@Alaashamel
Alaashamel merged commit 79ec618 into main Aug 20, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant