Repository navigation
docs: architecture diagrams + comprehensive API/AI/database documentation - #32
Merged
Merged
Conversation
…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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
API Reference (
docs/api/README.md)Complete endpoint documentation for all 85 HTTP endpoints + 6 Socket.io events:
AI Service Docs (
docs/ai/README.md)Database Docs (
docs/database/README.md)