Skip to content

Team-Deepiri/diri-cyrex

Repository files navigation

Cyrex Documentation

Welcome to the Cyrex AI platform documentation. This directory contains comprehensive documentation organized by topic.

Documentation Structure

Quick start guides and tutorials to get you up and running quickly.

🏗️ Architecture

System architecture, design patterns, and core system documentation.

Detailed documentation for specific features and capabilities.

AI Agents

RAG (Retrieval-Augmented Generation)

Vendor Fraud Detection

Automation

Workflows & Interfaces

Development guides, training documentation, and technical deep-dives.

Training & Models

Local Development

Advanced Techniques

Build, deployment, optimization, and operational documentation.

Quick Navigation

For New Users

  1. Start with How to Use Cyrex
  2. Review the Architecture overview
  3. Explore specific Features you're interested in

For Developers

  1. Check Development guides for setup
  2. Review Core Systems for architecture
  3. See Operations for build and deployment

For Feature Users

  1. Browse Features for specific capabilities
  2. Use Getting Started guides for quick setup
  3. Refer to Architecture for system understanding

For Testing & Development

  1. Use LangGraph Workflow Playground for workflow testing
  2. Check Development guides for setup
  3. Review Operations for build and deployment

Additional Resources

  • Root README: See the main project README for project overview
  • API Documentation: API endpoints are documented in the codebase
  • Code Comments: Inline documentation in source files
  • Component READMEs:

Documentation Updates

This documentation is actively maintained. If you find issues or have suggestions:

  1. Check if the information exists in another section
  2. Review the codebase for the latest implementation
  3. Update documentation as needed

About

Cyrex Agentic Runtime Framework

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors