Skip to content

Commit 2535aaa

Browse files
committed
Doc Update
1 parent 30480c4 commit 2535aaa

File tree

17 files changed

+356
-147
lines changed

17 files changed

+356
-147
lines changed

README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
# CodeOptiX
66

7-
**Agentic Code Optimization. Elevated Agent Experience.**
7+
**Agentic Code Optimization & Deep Evaluation for Superior Coding Agent Experience**
88

9-
*Code Optimization Engine for every coding agent. Powered by Agent Optimizers like GEPA (Genetic-Pareto) and Bloom-style scenario generation for behavior testing.*
9+
*CodeOptiX is the universal code optimization engine that improves coding agent experience with deep evaluations and optimization. When AI coding agents dazzle with impressive code but leave you wondering about quality, maintainability, security, and reliability, CodeOptiX ensures proper behavior through evaluations, reflection, and self-improvement. Powered by GEPA optimization and Bloom scenario generation.*
1010

1111
[![PyPI version](https://badge.fury.io/py/codeoptix.svg)](https://pypi.org/project/codeoptix/)
1212
[![CI](https://github.com/SuperagenticAI/codeoptix/actions/workflows/ci.yml/badge.svg)](https://github.com/SuperagenticAI/codeoptix/actions/workflows/ci.yml)
@@ -15,6 +15,11 @@
1515
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
1616
[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
1717

18+
<p align="center">
19+
<em>Built with ❤️ by <a href="https://super-agentic.ai" target="_blank"><strong>Superagentic AI</strong></a></em><br>
20+
<em>Advancing AI agent optimization and autonomous systems</em>
21+
</p>
22+
1823
[Documentation](https://superagenticai.github.io/codeoptix) |
1924
[Get Started](#-quick-start) |
2025
[Examples](https://github.com/SuperagenticAI/codeoptix/tree/main/examples) |
@@ -26,16 +31,20 @@
2631

2732
## What is CodeOptiX?
2833

29-
CodeOptiX is an **open-source agentic code optimization platform** for evaluating, testing, and improving AI coding agents. Built by [Superagentic AI](https://super-agentic.ai).
34+
**CodeOptiX is the universal code optimization engine that improves coding agent experience with deep evaluations and optimization.**
35+
36+
When AI coding agents dazzle with impressive code but leave you wondering about quality, maintainability, security, and reliability, CodeOptiX ensures proper behavior through evaluations, reflection, and self-improvement. Powered by GEPA optimization and Bloom scenario generation.
3037

31-
### Key Features
38+
Built by [**Superagentic AI**](https://super-agentic.ai) - *Advancing the future of AI agent optimization and autonomous systems.*
3239

33-
- **GEPA Optimization** - Automatically improve agent behavior using Genetic-Pareto Evolution
34-
- **Bloom Evaluations** - Deep behavioral evaluation with Bloom-style scenario generation
35-
- **Behavior Testing** - Test coding agents against configurable behavior specifications
36-
- **Agent-Agnostic** - Works with Claude Code, Codex, Gemini CLI, and any ACP-compatible agent
37-
- **Multi-Provider** - Supports OpenAI, Anthropic, Google, and Ollama (local, no API key!)
38-
- **CI/CD Ready** - GitHub Actions integration for automated quality gates
40+
### 🚀 Key Capabilities
41+
42+
- **🔍 Deep Behavioral Evaluation** - Comprehensive testing against security, reliability, and quality behaviors
43+
- **🧬 GEPA Optimization Engine** - [Genetic-Pareto Evolution](https://github.com/gepa-ai/gepa) for automatic agent improvement
44+
- **🌸 Bloom-Style Scenario Generation** - [Intelligent test case creation](https://github.com/safety-research/bloom) for thorough evaluation
45+
- **🎯 Multi-Agent Support** - Works with Claude Code, Codex, Gemini CLI, and custom agents
46+
- **🔧 Multi-Provider LLM Support** - OpenAI, Anthropic, Google, and Ollama (local models included!)
47+
- **⚡ CI/CD Integration** - Automated quality gates and GitHub Actions support
3948

4049
---
4150

@@ -207,6 +216,17 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](https:
207216

208217
<div align="center">
209218

210-
**Brought to you by [Superagentic AI](https://super-agentic.ai)**
219+
## 🤖 About Superagentic AI
220+
221+
**CodeOptiX is proudly built by [Superagentic AI](https://super-agentic.ai)**
222+
223+
*Advancing AI agent optimization and autonomous systems for the future of software development.*
224+
225+
### 🌟 Our Mission
226+
We're building the next generation of AI tools that enhance developer productivity and code quality through intelligent agent optimization.
227+
228+
### 🚀 Explore More
229+
- **[Superagentic AI Website](https://super-agentic.ai)** - Learn about our mission
230+
- **[Our Projects](https://github.com/SuperagenticAI)** - Discover other AI agent tools
211231

212232
</div>

docs/advanced/bloom.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ CodeOptiX integrates the Bloom framework for advanced scenario generation in beh
88

99
Bloom is an open-source framework originally developed by Anthropic for automated behavior evaluation of large language models. It provides sophisticated patterns for ideation, scenario generation, and behavioral testing.
1010

11+
**Learn more:** [Bloom Repository](https://github.com/safety-research/bloom)
12+
1113
### Why Bloom?
1214

1315
Bloom excels at:

docs/advanced/error-handling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,5 +205,5 @@ config = {
205205

206206
- [Python API Guide](../guides/python-api.md) - Error handling in Python
207207
- [CLI Usage Guide](../guides/cli-usage.md) - CLI error handling
208-
- [Package Distribution](distribution.md) - Distribution setup
208+
- [Configuration Guide](../guides/configuration.md) - Error handling configuration
209209

docs/advanced/gepa.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ CodeOptiX uses GEPA (Genetic-Pareto) to automatically improve agent prompts thro
88

99
**GEPA (Genetic-Pareto)** is a framework for optimizing textual system components (like AI prompts, code, or instructions) using LLM-based reflection and evolutionary search. GEPA employs iterative mutation, reflection, and Pareto-aware candidate selection to evolve robust, high-performing variants.
1010

11+
**Learn more:** [GEPA Repository](https://github.com/gepa-ai/gepa)
12+
1113
**Note**: CodeOptiX uses GEPA's `InstructionProposalSignature` component for prompt evolution. This is a minimal integration that uses GEPA's proven instruction proposal mechanism, rather than the full GEPA optimization framework.
1214

1315
---

docs/api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,5 +339,5 @@ Generate code using registered adapters.
339339

340340
---
341341

342-
For more details, see the [full API documentation](API.md).
342+
For usage examples, see the [Python API Guide](../guides/python-api.md).
343343

docs/concepts/overview.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,20 @@
22

33
Understanding the fundamental concepts behind CodeOptiX.
44

5-
> **Agentic Code Optimization. Elevated Agent Experience.** Code Optimization Engine for every coding agent. Powered by Agent Optimizers like GEPA (Genetic-Pareto) and Bloom-style scenario generation for behavior testing.
5+
> **Agentic Code Optimization & Deep Evaluation for Superior Coding Agent Experience.** CodeOptiX is the universal code optimization engine that improves coding agent experience with deep evaluations and optimization. When AI coding agents dazzle with impressive code but leave you wondering about quality, maintainability, security, and reliability, CodeOptiX ensures proper behavior through evaluations, reflection, and self-improvement.
66
77
---
88

99
## What is CodeOptiX?
1010

11-
CodeOptiX is an **agentic code optimization platform** for AI coding agents. It helps you:
11+
CodeOptiX is an **advanced evaluation and optimization platform** for AI coding agents. It provides comprehensive testing, analysis, and improvement capabilities to ensure your coding agents produce high-quality, reliable code.
1212

13-
-**Evaluate** agent behavior
14-
-**Reflect** on results
15-
-**Evolve** agent prompts
13+
### Key Capabilities
14+
15+
- 🔍 **Deep Evaluation** - Comprehensive behavioral testing of coding agents
16+
- 📊 **Detailed Analysis** - In-depth performance metrics and issue identification
17+
- 🧠 **Smart Optimization** - [GEPA](https://github.com/gepa-ai/gepa)-powered prompt evolution and improvement
18+
- 🎯 **Quality Assurance** - Automated testing against security, reliability, and correctness behaviors
1619

1720
---
1821

docs/getting-started/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ CodeOptiX supports multiple LLM providers. Choose the one that works best for yo
7676
**No API key required!** Use local Ollama models:
7777

7878
```bash
79-
# 1. Install Ollama: https://ollama.ai
79+
# 1. Install Ollama: https://ollama.com
8080
# 2. Start Ollama service
8181
ollama serve
8282

@@ -161,7 +161,7 @@ Includes:
161161
CodeOptiX supports local Ollama models - no API key required!
162162

163163
**Prerequisites:**
164-
1. Install Ollama: https://ollama.ai
164+
1. Install Ollama: https://ollama.com
165165
2. Start Ollama service: `ollama serve`
166166
3. Pull a model: `ollama pull llama3.1:8b` (or `gpt-oss:120b`, `qwen3:8b`, etc.)
167167

0 commit comments

Comments
 (0)