Skip to content

Commit 5f2a333

Browse files
vivek5200vivek5200
committed
Updating a Docs
1 parent 65cfc51 commit 5f2a333

5 files changed

Lines changed: 80 additions & 53 deletions

File tree

‎docs/LMSTUDIO_SETUP.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
layout: default
3+
title: Phase 2
4+
nav_order: 3
5+
---
16
# LM Studio Setup Guide for Phase 2 Testing
27

38
## Why LM Studio?

‎docs/PHASE1_COMPLETE.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
layout: default
3+
title: Phase 1
4+
nav_order: 2
5+
---
16
# Phase 1: The Librarian - COMPLETION REPORT
27

38
## 🎉 Status: ALL TASKS COMPLETE (4/4)

‎docs/PHASE2_DOCUMENTATION.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
layout: default
3+
title: Phase 2
4+
nav_order: 3
5+
---
16
# Phase 2: The Reasoner - Complete Documentation
27
**Date:** December 9, 2025
38
**Status:** ✅ FULLY IMPLEMENTED AND TESTED

‎docs/_config.yml‎

Lines changed: 38 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,49 @@
1-
# Ouroboros Documentation Site Configuration
2-
title: Ouroboros Documentation
1+
# ------------------------------------
2+
# Ouroboros Site Configuration
3+
# ------------------------------------
4+
title: Ouroboros Docs
35
description: AI-powered code refactoring system
4-
baseurl: "" # the subpath of your site, e.g. /blog
5-
url: "https://docs.vivekbendre.me" # the base hostname & protocol
6+
url: "https://docs.vivekbendre.me"
67

7-
# Theme Configuration
8-
remote_theme: pages-themes/cayman@v0.2.0
9-
plugins:
10-
- jekyll-remote-theme
11-
# Alternative popular themes (uncomment one to use):
12-
# remote_theme: pages-themes/minimal@v0.2.0
13-
# remote_theme: pages-themes/slate@v0.2.0
14-
# remote_theme: pages-themes/architect@v0.2.0
15-
# remote_theme: pages-themes/hacker@v0.2.0
16-
# remote_theme: pages-themes/midnight@v0.2.0
17-
18-
# Build settings
8+
# ------------------------------------
9+
# THEME SETTINGS (Just the Docs)
10+
# ------------------------------------
11+
remote_theme: just-the-docs/just-the-docs
12+
13+
# Enable the built-in search engine
14+
search_enabled: true
15+
search:
16+
# Split pages into sections for better search results
17+
heading_level: 2
18+
previews: 3
19+
20+
# Visual Appearance
21+
color_scheme: dark # Options: light, dark, system (default: system)
22+
23+
# Call to Action button in top right
24+
aux_links:
25+
"View on GitHub":
26+
- "//github.com/vivek5200/ouroboros"
27+
28+
# Footer Content
29+
footer_content: "Copyright © 2025 Vivek Bendre. Distributed by an MIT license."
30+
31+
# ------------------------------------
32+
# BUILD SETTINGS
33+
# ------------------------------------
1934
markdown: kramdown
2035
plugins:
2136
- jekyll-remote-theme
22-
- jekyll-feed
2337
- jekyll-seo-tag
38+
- jekyll-feed
2439

25-
# GitHub metadata
40+
# GitHub Metadata (Auto-populates some variables)
2641
repository: vivek5200/ouroboros
2742
github_username: vivek5200
2843

29-
# Navigation
30-
navigation:
31-
- title: Home
32-
url: /
33-
- title: Phase 1
34-
url: /PHASE1_COMPLETE
35-
- title: Phase 2
36-
url: /PHASE2_DOCUMENTATION
37-
- title: LM Studio Setup
38-
url: /LMSTUDIO_SETUP
39-
40-
# Exclude from processing
44+
# ------------------------------------
45+
# EXCLUDES
46+
# ------------------------------------
4147
exclude:
4248
- venv/
4349
- __pycache__/
@@ -47,4 +53,5 @@ exclude:
4753
- .git/
4854
- .gitignore
4955
- requirements.txt
50-
- README.md
56+
- Gemfile
57+
- Gemfile.lock

‎docs/index.md‎

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,41 @@
11
---
2-
layout: default
2+
layout: home
33
title: Home
4+
nav_order: 1
45
---
56

6-
# Ouroboros Documentation
7+
# Ouroboros
8+
{: .fs-9 }
79

8-
Welcome to the official documentation for **Ouroboros** - an AI-powered code refactoring system.
10+
**AI-powered code refactoring system**
11+
{: .fs-6 .fw-300 }
912

10-
## Contents
13+
[Get Started](./PHASE2_DOCUMENTATION){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } [View on GitHub](https://github.com/vivek5200/ouroboros){: .btn .fs-5 .mb-4 .mb-md-0 }
1114

12-
### Phase 1: The Librarian
13-
- [Phase 1 Documentation](PHASE1_COMPLETE.md) - Code parsing and graph database construction
15+
---
1416

15-
### Phase 2: The Reasoner
16-
- [Phase 2 Complete Documentation](PHASE2_DOCUMENTATION.md) - LLM-powered refactor plan generation
17-
- [LM Studio Setup Guide](LMSTUDIO_SETUP.md) - FREE local LLM testing with DeepSeek-R1
17+
## Project Overview
1818

19-
### Legacy Documentation
20-
- [Phase 2 Bridge Documentation](PHASE2_BRIDGE.md) - Bridge implementation (archived)
19+
Ouroboros is an autonomous agent designed to self-correct and refactor codebases. It utilizes advanced LLM integration to analyze project structure and implement optimizations.
2120

22-
---
21+
### Key Features
22+
23+
* **⚡ Automated Refactoring**: Intelligent code analysis.
24+
* **🧠 LLM Integration**: Powered by LM Studio / Local LLMs.
25+
* **🔄 Self-Healing**: Detects errors and proposes fixes iteratively.
2326

24-
## Quick Links
27+
### Documentation Status
2528

26-
- **Repository:** [github.com/vivek5200/ouroboros](https://github.com/vivek5200/ouroboros)
27-
- **Latest Commit:** `4e09d28` (December 9, 2025)
28-
- **Status:** Phase 2 Complete ✅ - Ready for Phase 3
29+
| Module | Status | Description |
30+
|:-------|:-------|:------------|
31+
| **Phase 1** | ✅ Complete | Core logic and basic refactoring agents. |
32+
| **Phase 2** | 🚧 In Progress | Advanced context retention and vector database integration. |
33+
34+
---
2935

30-
## Key Features
36+
### Installation
3137

32-
✅ **6 LLM Providers** - Claude, Gemini, Jamba, OpenAI, LM Studio, Mock
33-
✅ **Cost Optimized** - Gemini 2.5 Flash at $0.0007/request (98% cheaper than Claude)
34-
✅ **100% Test Coverage** - 6/6 tests passing
35-
✅ **Neo4j Integration** - Full Phase 1 graph database support
36-
✅ **FREE Local Testing** - LM Studio with DeepSeek-R1
38+
```bash
39+
git clone [https://github.com/vivek5200/ouroboros.git](https://github.com/vivek5200/ouroboros.git)
40+
cd ouroboros
41+
pip install -r requirements.txt

0 commit comments

Comments
 (0)