Documentation

Ediky engineering documentation

Architecture, pipelines, APIs, and the decisions behind them — the single source of truth for every repository in the Ediky ecosystem.

Getting startedWhat Ediky is, how the repositories fit together, and how to read these docs.System architectureThe platform end to end: hosting, data, execution, and the tradeoffs behind them.Cross-repositoryDependencies, communication, data flow and end-to-end journeys across repositories.TemplatesPage templates and generators for adding a repository, module, component, function or API.

Explore by repository

Every repository has the same sections: overview, architecture, modules, components, functions, APIs, configuration, dependencies and contributing.

ediky-websiteThe Ediky product: React SPA, Cloudflare Pages Functions, Workers and question-bank content.ediky-desktopDesktop client for Ediky, built with Tauri.ediky-sharedTODO: One-line description of what this repository provides.ediky_toolsTools for automating question generation and validation.DocyStorage for personalised Ediky notes, fetched by the app at runtime.ci-infraCentralized DevOps and GitOps infrastructure hub for the Ediky ecosystem.ediky-coreThis documentation portal (Ediky Workflow), built with VitePress.

Guides

In-depth guides to how the platform works today.

• Ecosystem mapFour private repos — the website, ediky_tools, Docy, and these docs — and exactly how data flows between them, from an OA screenshot to a judged submission.
• Architecture, honestlyReact 19 SPA on Cloudflare Pages, Firebase Auth + Firestore, self-hosted Judge0, and Workers for cron — with the tradeoffs stated, not hidden.
• Content at scaleWhy the question bank ships as sharded JSON indexes + on-demand markdown bodies instead of import.meta.glob — and the 20,000-file limit that forced it.
• OA Simulator internalsServer-anchored timers, one-way section locks, marking schemes, and the background Worker that finishes judging even after the tab closes.
• The AI pipelineOne provider chain — Gemini → Groq → Cerebras → Mistral → NVIDIA → GitHub → Cohere → Ollama → OpenRouter — behind grading, tutoring, review, and these docs' own assistant.
• The content factoryqgen for DSA (fuzzers, brute-force verifiers, adversarial cases), plus the CS, Aptitude, and SQL pipelines that validate and ship straight into the app.
• Auth, data & rulesThe Firebase authentication flow, the full Firestore schema, and the owner-only security rules that make "no backend" safe.
• Performance playbookSession-cached index shards, dependency-free row virtualization, deferred search, lazy routes — the ~300KB gzip the bundle lost, and how.
• Desktop appArchitecture, frontend, backend services, data flows, security and deployment of the desktop client.
• ContributingDevelopment setup, coding standards, the content linter that gates every deploy, and a troubleshooting guide for the failures we've already met.