System Overview & Architecture
This section documents the foundational architecture and automated governance framework supporting the documentation site and developer experience platform.
🏗️ Core Architectural Stack
The portal integrates automated documentation generation, LLM-based quality evaluation, continuous integration via GitHub Actions, and an interactive RAG (Retrieval-Augmented Generation) assistant.
| Component | Technology | Purpose |
|---|---|---|
| Static Site Generator | Jekyll + Just the Docs theme | Renders structured technical documentation and navigation hierarchies. |
| Quality Engine | Python 3 + Gemini 2.5 Flash API | Performs automated code & style audits on modified Markdown files. |
| Gap Detection & Patching | LangGraph Orchestrator | Identifies content gaps and generates initial doc stubs. |
| Search & AI Assistant | Custom RAG Engine + Cloudflare Workers | Embeds site content into a vector DB and powers the real-time RAGbot widget. |
🔄 High-Level Workflow Sequence
[ Developer / PR ] ──> [ GitHub Actions Runner ] │ ├──> Parses Changed Files (.md) ├──> Filters Out Auto-Generated Stubs (docs/gaps/) ├──> Calls Gemini Quality Guardrails API └──> Posts Automated Evaluation Comment to PR
📌 Sub-Sections
- Quality Guardrails Engine: Details on rate-limit parsing, PR automated reviews, and error handling.
- RAGbot Widget Integration: Architecture and UI behavior of the embedded chat widget.