GodSpeed / Docs /README.md
Ananth Shyam
Implement anomaly detection and forecasting features
451d52a

/docs โ€” Enterprise Knowledge Copilot

Living documentation for the Enterprise Knowledge Copilot system. Read in order before writing code. Update when architecture changes.


Document Map

File Contents Read When
01_problem_and_architecture.md Problem statement, objectives, system overview, all 5 areas, agentic design, user roles, design principles First. Always read this first.
02_rag_pipeline_and_validation.md Ingestion pipeline, chunking, T1/T2/T3 retrieval, dual index, GLiNER PII, Generator+Critic validation, Knowledge Loop, Dependency Tracker Building ingestion, retrieval, or validation components
03_analytics_and_intelligence.md Query classification, interaction log schema, retrieval feedback loop, NL analytics, health dashboard, proactive agent, silo detector, Areas 4 & 5 planned specs Building analytics, dashboards, or Area 3 agents
04_integrations_and_tech_stack.md Notion, Confluence, GitHub integration specs with full code; RBAC enforcement; change detection; tech stack; local dev setup; env vars Building any integration or setting up development environment
05_market_strategy_and_gtm.md Target customer, tool strategy, competitor analysis, USPs, country-by-country market analysis, GTM sequencing Product, positioning, or expansion decisions
anomaly-and-forecasting/ Area 4 implementation docs โ€” data layer, detection algorithms, API reference, Celery scheduling Building or extending anomaly detection, forecasting, or the Anomalies frontend tab

The Five Focus Areas at a Glance

Area 1 โ€” Hybrid RAG System          [Core โ€” Implemented]
Area 2 โ€” Data Pipelines & Validation [Core โ€” Implemented]
Area 3 โ€” Analytics & NL Intelligence [Core โ€” Implemented]
Area 4 โ€” Anomaly & Forecasting       [Implemented โ€” branch: anomaly-and-forecasting]
Area 5 โ€” Knowledge Graph             [Implemented]

All five areas are one system โ€” not five products. See 01_problem_and_architecture.md for the interaction map.


Quick Reference

Primary Tool Integrations

  • Notion โ†’ 04_integrations_and_tech_stack.md#2-notion-integration
  • Confluence โ†’ 04_integrations_and_tech_stack.md#3-confluence-integration
  • GitHub โ†’ 04_integrations_and_tech_stack.md#4-github-integration

Key Architectural Decisions

  • One agent, one tool (never multi-tool agents)
  • GLiNER runs locally โ€” zero data egress, always
  • Generator and Critic are always separate agents
  • Semantic chunking only โ€” no fixed-size splits
  • Every interaction is a logged data point feeding Area 3

Launch Markets

  1. ๐Ÿ‡ฎ๐Ÿ‡ณ India โ€” DPDP compliance moat, zero competition, perfect tool stack
  2. ๐Ÿ‡ธ๐Ÿ‡ฌ Singapore โ€” SEA regional HQ beachhead
  3. ๐Ÿ‡ฆ๐Ÿ‡บ Australia โ€” English-language, Privacy Act reform, same tool stack