diff --git a/documentation/docs.json b/documentation/docs.json index a705f779..b3d12343 100644 --- a/documentation/docs.json +++ b/documentation/docs.json @@ -11,12 +11,23 @@ "navigation": { "tabs": [ { - "tab": "Guides", + "tab": "Wavefront", "groups": [ { "group": "Getting started", "pages": [ - "index", + "index" + ] + } + ] + }, + { + "tab": "FloAI", + "groups": [ + { + "group": "Getting started", + "pages": [ + "flo-ai", "quickstart", "development" ] @@ -78,21 +89,21 @@ }, "contextual": { "options": [ - "copy", - "view", - "chatgpt", - "claude", - "perplexity", - "mcp", - "cursor", - "vscode" - ] + "copy", + "view", + "chatgpt", + "claude", + "perplexity", + "mcp", + "cursor", + "vscode" + ] }, "footer": { "socials": { "x": "https://x.com/rootflo", - "github": "https://github.com/rootflo/flo-ai", + "github": "https://github.com/rootflo/wavefront", "linkedin": "https://linkedin.com/company/rootflo" } } -} +} \ No newline at end of file diff --git a/documentation/flo-ai.mdx b/documentation/flo-ai.mdx new file mode 100644 index 00000000..7a2d0d96 --- /dev/null +++ b/documentation/flo-ai.mdx @@ -0,0 +1,95 @@ +--- +title: "Flo AI Documentation" +description: "Build production-ready AI agents with structured outputs, tool integration, and multi-LLM support" +--- + +## Welcome to Flo AI (Wavefront coming soon) 🌊 + +Flo AI is a Python framework that makes building production-ready AI agents and teams as easy as writing YAML. Think "Kubernetes for AI Agents" - compose complex AI architectures using pre-built components while maintaining the flexibility to create your own. + + + Get started with Flo AI in minutes - from installation to your first agent. + + +## Key Features + + + + Build complex AI systems by combining smaller, reusable components. + + + Built-in observability for production deployments. + + + Define your entire agent architecture in simple YAML configurations. + + + Intelligent routing decisions made by LLMs, no code required. + + + +## Core Capabilities + +Everything you need to build sophisticated AI agents and workflows. + + + + Support for OpenAI, Anthropic, Google, Ollama, and more with consistent interfaces. + + + Easy tool creation with the @flo_tool decorator and LangChain compatibility. + + + Design AI workflows visually with our React-based studio interface. + + + Built-in observability with automatic instrumentation for production monitoring. + + + +## Get Started + + + Explore comprehensive examples and use cases in our GitHub repository. + diff --git a/documentation/images/wavefront-arc.png b/documentation/images/wavefront-arc.png new file mode 100644 index 00000000..4550a93b Binary files /dev/null and b/documentation/images/wavefront-arc.png differ diff --git a/documentation/index.mdx b/documentation/index.mdx index 9b1c8c2b..46e93657 100644 --- a/documentation/index.mdx +++ b/documentation/index.mdx @@ -1,97 +1,90 @@ --- -title: "Flo AI Documentation" -description: "Build production-ready AI agents with structured outputs, tool integration, and multi-LLM support" +title: "Project Overview" --- -Wavefront documentation will be updated soon, along with code release - -## Welcome to Flo AI (Wavefront coming soon) 🌊 - -Flo AI is a Python framework that makes building production-ready AI agents and teams as easy as writing YAML. Think "Kubernetes for AI Agents" - compose complex AI architectures using pre-built components while maintaining the flexibility to create your own. - - - Get started with Flo AI in minutes - from installation to your first agent. - - -## Key Features - - - - Build complex AI systems by combining smaller, reusable components. - - - Built-in observability for production deployments. - - - Define your entire agent architecture in simple YAML configurations. - - - Intelligent routing decisions made by LLMs, no code required. - - - -## Core Capabilities - -Everything you need to build sophisticated AI agents and workflows. - - - - Support for OpenAI, Anthropic, Google, Ollama, and more with consistent interfaces. - - - Easy tool creation with the @flo_tool decorator and LangChain compatibility. - - - Design AI workflows visually with our React-based studio interface. - - - Built-in observability with automatic instrumentation for production monitoring. - - - -## Get Started - - - Explore comprehensive examples and use cases in our GitHub repository. - +# 🚀 Wavefront AI Middleware + +Wavefront AI is an open-source middleware platform designed to seamlessly integrate AI-driven agents, workflows, and data sources across enterprise environments. It acts as a connective layer that bridges modular frontend applications with complex backend data pipelines, ensuring secure access, observability, and compatibility with modern AI and data infrastructures. + +**Status**: Pre-release (Under active development) +**Beta release**: Dec 2025 +**Wavefront License**: GNU AFFERO GENERAL PUBLIC LICENSE 3.0 +**FloAI License**: MIT LICENSE +**Contributing**: We welcome early feedback! See [CONTRIBUTING.md](CONTRIBUTING.md). +**Community**: Join our discord at https://discord.gg/BPXsNwfuRU + +FloAI documentation available at [FloAI](/flo-ai) + +## ✨ Key Capabilities + +- **🎯 Modular AI Application Integration** + Deploy diverse AI agents for auditing, underwriting, contact center supervision, and business process automation without rebuilding infrastructure. + +- **🔌 Unified API Layer** + Standardized APIs for developing, deploying, and managing AI workflows across multiple use cases and frameworks. + +- **🔐 Enterprise-Grade Authentication & Authorization** + Native integrations with Google Auth, LDAP, Auth0, Okta, and Microsoft AD/Entra for seamless SSO and access controls. + +- **🌐 Comprehensive Data Connectivity** + Ingest data from OLAP/OLTP systems (BigQuery, Redshift), HDFS, cloud storage (S3, GCS), databases (PostgreSQL, MongoDB), and enterprise APIs (Salesforce, SAP). + +- **👥 Granular Role-Based Access Control** + Fine-grained permissions for both AI agents and data sources, ensuring compliance and least-privilege access. + +- **🤖 Open Source & Proprietary Model Support** + Works seamlessly with open-source LLMs/SLMs, custom models, and proprietary AI services. + +- **📊 Observability, Monitoring & Evaluation** + Built-in telemetry with Grafana and Prometheus support. Track agent performance, audit trails, and guardrail enforcement in real-time. + +- **🤖 No Code Agent & Workflow Builder** + Built-in capabilities to build and customer AI agents, and AI Workflows, connecting Data Sources, Knowledge Bases, in minutes + +- **🔊 Voice & Conversational Agents** + Integrated Voice-to-Voice Bots, ASR models, and agentic flows for contact center and conversational use cases. + +- **🧠 Knowledge Bases & RAG Ready** + Native support for Retrieval-Augmented Generation with MCP connectors and external knowledge bases. + +--- + +## 🏗️ Architecture Overview + +

+ Rootflo +

+ +### Layer Descriptions + +| Layer | Purpose | Components | +|-------|---------|------------| +| **Frontend Applications** | User-facing AI interfaces | Supervisors, Audit Agents, Underwriters, Copilots | +| **API Layer** | Standardized communication | Frontend SDK, REST/GraphQL APIs | +| **Authentication** | Identity verification & SSO | Google Auth, LDAP, Auth0, Okta, Microsoft AD | +| **Authorization (Agents)** | Agent-level access policies | Role definitions, permission mapping | +| **AI Workflows** | Intelligent automation | Agentic flows, Voice agents, LLM integrations, RAG | +| **Data Processing** | ETL and API management | Pipelines, transformations, HTTP endpoints | +| **Authorization (Data)** | Data source access control | Fine-grained permissions, audit logging | +| **Data Sources** | Enterprise data systems/Services | Databases, APIs, Cloud storage, Data warehouses, Servics like Salesforce, SAP etc. | + +## Platform Components + +As part of the project, we are building the following components + +- [FloAI](https://github.com/rootflo/flo-ai/tree/develop/flo_ai) library for Agent Building & A2A Orchestration +- **Wavefront Core** Middleware Service, which connects multiple frontend applications with complex backend ai pipelines, provides authentication, authorization, observability, monitoring & evaluation +- **Wavefront Control Panel** Unified frontend for configuring agents, workflows, AI models, Guardrails developer-friendly, RBAC etc. +- **Wavefront cli** for configuring through cli (Yet to Build), for full developer-friendly control + + +### Release Timeline + +| Quarter | Milestone | Features | +|---------|-----------|----------| +| **Nov 2025** | Public README.md | Publish readme and take in community feedback | +| **Dec 2025** | Open-source community edition | Community edition release with working MVP | +| **Q1 2026** | Enterprise Edition | Advanced RBAC, More Data source Integrations| +| **Q1 2026** | Rootflo Wavefront Cloud | One-click deployable Wavefront Cloud + +**Join our discord at https://discord.gg/BPXsNwfuRU** to get early access to the platform and to provide feedback \ No newline at end of file diff --git a/documentation/logo/dark.png b/documentation/logo/dark.png index 8e8304e8..62132ae5 100644 Binary files a/documentation/logo/dark.png and b/documentation/logo/dark.png differ diff --git a/documentation/logo/light.png b/documentation/logo/light.png index 8e8304e8..d72b4cfa 100644 Binary files a/documentation/logo/light.png and b/documentation/logo/light.png differ