Skip to content

Commit 20bbf2d

Browse files
byerlikayabyerlikaya
committed
docs: fix broken links and add technology logos section
- Fix broken links in getting-started.md and api-reference.md - Add technology logos section with AI providers and storage providers - Add CSS styles for tech-logo-card components - Update external links to open in new tabs - Replace 'Community Driven' with 'Open Source' for accuracy
1 parent d297fe1 commit 20bbf2d

File tree

8 files changed

+793
-52
lines changed

8 files changed

+793
-52
lines changed

‎docs/_config.yml‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,10 @@ defaults:
3434
type: "pages"
3535
values:
3636
layout: "default"
37-
search: true
3837
top_level: true
3938
author: "Barış Yerlikaya"
4039
image: "/assets/images/logo.svg"
4140

42-
# Search
43-
search_enabled: true
44-
search:
45-
heading_level: 2
46-
previews: 3
47-
preview_words_before: 5
48-
preview_words_after: 10
49-
tokenizer_separator: /[\s/]+/
50-
5141
# UI
5242
color_scheme: light
5343
back_to_top: true

‎docs/api-reference.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -483,6 +483,6 @@ See [Getting Started]({{ site.baseurl }}/getting-started) for complete usage exa
483483
## 🆘 Support
484484

485485
For questions about the API, please:
486-
- 📖 Check the [main documentation](../README.md)
487-
- 🐛 [Open an issue](https://github.com/byerlikaya/SmartRAG/issues)
488-
- 📧 [Contact support](mailto:b.yerlikaya@outlook.com)
486+
- 📖 [Back to Documentation]({{ site.baseurl }}/) - Main documentation
487+
- 🐛 [Open an issue](https://github.com/byerlikaya/SmartRAG/issues) - GitHub Issues
488+
- 📧 [Contact support](mailto:b.yerlikaya@outlook.com) - Email support

‎docs/assets/css/style.css‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,49 @@ body {
9898
.feature-icon {
9999
width: 80px;
100100
height: 80px;
101+
}
102+
103+
/* Technology Logo Cards */
104+
.tech-logo-card {
105+
background: white;
106+
border-radius: 16px;
107+
box-shadow: 0 4px 20px rgba(0, 0, 0, 0.08);
108+
transition: all 0.3s ease;
109+
border: 1px solid var(--border-color);
110+
height: 100%;
111+
}
112+
113+
.tech-logo-card:hover {
114+
transform: translateY(-5px);
115+
box-shadow: 0 20px 40px rgba(0, 0, 0, 0.15);
116+
border-color: var(--primary-color);
117+
}
118+
119+
.tech-logo {
120+
display: flex;
121+
justify-content: center;
122+
align-items: center;
123+
margin-bottom: 1rem;
124+
}
125+
126+
.tech-logo i {
127+
transition: all 0.3s ease;
128+
}
129+
130+
.tech-logo-card:hover .tech-logo i {
131+
transform: scale(1.1);
132+
}
133+
134+
.tech-logo-card h6 {
135+
font-weight: 600;
136+
color: var(--text-primary);
137+
margin-bottom: 0.5rem;
138+
}
139+
140+
.tech-logo-card small {
141+
color: var(--text-secondary);
142+
font-size: 0.85rem;
143+
}
101144
margin: 0 auto;
102145
display: flex;
103146
align-items: center;

‎docs/assets/js/main.js‎

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ document.addEventListener('DOMContentLoaded', function() {
77
initNavbarEffects();
88
initSidebarEffects();
99
initCodeHighlighting();
10-
initSearchFunctionality();
1110
initAnimations();
1211
});
1312

@@ -118,35 +117,6 @@ function initCodeHighlighting() {
118117
});
119118
}
120119

121-
// Search Functionality
122-
function initSearchFunctionality() {
123-
const searchInput = document.createElement('input');
124-
searchInput.type = 'text';
125-
searchInput.className = 'form-control';
126-
searchInput.placeholder = 'Search documentation...';
127-
searchInput.style.marginBottom = '1rem';
128-
129-
const sidebarHeader = document.querySelector('.sidebar-header');
130-
if (sidebarHeader) {
131-
sidebarHeader.appendChild(searchInput);
132-
}
133-
134-
searchInput.addEventListener('input', function() {
135-
const query = this.value.toLowerCase();
136-
const sidebarLinks = document.querySelectorAll('.sidebar-nav .nav-link');
137-
138-
sidebarLinks.forEach(link => {
139-
const text = link.textContent.toLowerCase();
140-
if (text.includes(query)) {
141-
link.style.display = 'block';
142-
link.style.opacity = '1';
143-
} else {
144-
link.style.opacity = '0.3';
145-
}
146-
});
147-
});
148-
}
149-
150120
// Animations
151121
function initAnimations() {
152122
const observerOptions = {

‎docs/changelog.md‎

Lines changed: 245 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,245 @@
1+
---
2+
layout: default
3+
title: Changelog
4+
description: Version history and release notes for SmartRAG - Track new features, improvements, and bug fixes
5+
---
6+
7+
# Changelog
8+
9+
All notable changes to SmartRAG will be documented in this file.
10+
11+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
12+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
13+
14+
## [Unreleased]
15+
16+
### Planned
17+
- 🔮 **Performance Optimizations** - Enhanced caching and memory management
18+
- 🔮 **Additional AI Providers** - Support for more embedding services
19+
- 🔮 **Advanced Search Algorithms** - Improved semantic search capabilities
20+
- 🔮 **Monitoring & Metrics** - Built-in performance monitoring
21+
22+
---
23+
24+
## [1.0.3] - 2025-01-XX
25+
26+
### 🚀 Added
27+
- **Enhanced Semantic Search** - Advanced hybrid scoring system with semantic similarity (80%) and keyword relevance (20%)
28+
- **Smart Document Chunking** - Word boundary validation and optimal break point detection
29+
- **Language-Agnostic Design** - Support for any language without hardcoded patterns
30+
- **VoyageAI Integration** - High-quality embeddings for Anthropic Claude models
31+
- **Configuration Priority System** - User settings take absolute priority over defaults
32+
- **Performance Optimizations** - Faster chunking and search operations
33+
34+
### 🔧 Improved
35+
- **Document Processing** - Better handling of complex document formats
36+
- **Error Handling** - More descriptive error messages and graceful degradation
37+
- **Memory Management** - Optimized memory usage for large documents
38+
- **Search Accuracy** - Improved relevance scoring and result ranking
39+
40+
### 🐛 Fixed
41+
- **Memory Leaks** - Resolved memory leaks in document processing
42+
- **Search Performance** - Fixed slow search queries with large datasets
43+
- **Document Parsing** - Improved handling of corrupted or malformed files
44+
- **Thread Safety** - Enhanced thread safety in concurrent operations
45+
46+
---
47+
48+
## [1.0.2] - 2024-12-XX
49+
50+
### 🚀 Added
51+
- **Redis Storage Provider** - High-performance Redis backend support
52+
- **SQLite Storage Provider** - Lightweight local database option
53+
- **Document Versioning** - Track document changes and updates
54+
- **Batch Processing** - Process multiple documents simultaneously
55+
- **Export Functionality** - Export processed documents in various formats
56+
57+
### 🔧 Improved
58+
- **API Performance** - Faster response times for search operations
59+
- **Error Logging** - Enhanced logging with structured data
60+
- **Configuration Validation** - Better validation of configuration options
61+
- **Memory Usage** - Reduced memory footprint
62+
63+
### 🐛 Fixed
64+
- **Search Accuracy** - Improved relevance scoring algorithm
65+
- **Document Parsing** - Better handling of edge cases
66+
- **Memory Management** - Fixed memory leaks in long-running operations
67+
- **API Stability** - Resolved intermittent API failures
68+
69+
---
70+
71+
## [1.0.1] - 2024-11-XX
72+
73+
### 🚀 Added
74+
- **Qdrant Vector Database** - High-performance vector storage backend
75+
- **OpenAI Integration** - Support for OpenAI GPT models and embeddings
76+
- **Anthropic Integration** - Support for Claude models
77+
- **Document Chunking** - Intelligent document segmentation
78+
- **Basic Search API** - Simple search functionality
79+
80+
### 🔧 Improved
81+
- **Core Architecture** - More modular and extensible design
82+
- **Error Handling** - Better error messages and recovery
83+
- **Performance** - Optimized document processing pipeline
84+
- **Documentation** - Comprehensive API documentation
85+
86+
### 🐛 Fixed
87+
- **Initial Release Issues** - Resolved various startup problems
88+
- **Memory Usage** - Fixed excessive memory consumption
89+
- **API Stability** - Improved overall system stability
90+
91+
---
92+
93+
## [1.0.0] - 2024-10-XX
94+
95+
### 🎉 Initial Release
96+
- **Core RAG Framework** - Basic retrieval-augmented generation system
97+
- **Document Processing** - Support for Word, PDF, and text documents
98+
- **In-Memory Storage** - Simple in-memory document storage
99+
- **Basic Search** - Simple keyword-based search
100+
- **.NET 9.0 Support** - Built for the latest .NET version
101+
- **Extensible Architecture** - Plugin-based design for easy customization
102+
103+
---
104+
105+
## 🔄 Migration Guide
106+
107+
### Upgrading from 1.0.2 to 1.0.3
108+
109+
#### Breaking Changes
110+
- None
111+
112+
#### New Configuration Options
113+
```json
114+
{
115+
"SmartRAG": {
116+
"MaxChunkSize": 1200,
117+
"MinChunkSize": 150,
118+
"ChunkOverlap": 250,
119+
"EnableWordBoundaryValidation": true,
120+
"EnableOptimalBreakPoints": true,
121+
"SemanticScoringWeight": 0.8,
122+
"KeywordScoringWeight": 0.2
123+
}
124+
}
125+
```
126+
127+
#### Code Changes
128+
```csharp
129+
// Old way (still supported)
130+
services.AddSmartRAG(options =>
131+
{
132+
options.AIProvider = AIProvider.OpenAI;
133+
options.StorageProvider = StorageProvider.InMemory;
134+
});
135+
136+
// New way (recommended)
137+
services.AddSmartRAG(configuration, options =>
138+
{
139+
options.StorageProvider = StorageProvider.InMemory;
140+
options.AIProvider = AIProvider.OpenAI;
141+
});
142+
```
143+
144+
### Upgrading from 1.0.1 to 1.0.2
145+
146+
#### Breaking Changes
147+
- None
148+
149+
#### New Features
150+
- Redis and SQLite storage providers
151+
- Document versioning system
152+
- Batch processing capabilities
153+
154+
### Upgrading from 1.0.0 to 1.0.1
155+
156+
#### Breaking Changes
157+
- None
158+
159+
#### New Features
160+
- Qdrant vector database support
161+
- OpenAI and Anthropic integrations
162+
- Enhanced document chunking
163+
164+
---
165+
166+
## 📊 Version Support
167+
168+
| Version | .NET Version | Status | Support Until |
169+
|---------|--------------|---------|----------------|
170+
| 1.0.3 | 9.0+ | ✅ Current | 2026-01-XX |
171+
| 1.0.2 | 9.0+ | 🔄 LTS | 2025-12-XX |
172+
| 1.0.1 | 9.0+ | 🔄 LTS | 2025-11-XX |
173+
| 1.0.0 | 9.0+ | ❌ EOL | 2025-10-XX |
174+
175+
**Legend:**
176+
- ✅ **Current** - Latest version with full support
177+
- 🔄 **LTS** - Long-term support version
178+
- ❌ **EOL** - End of life, no more updates
179+
180+
---
181+
182+
## 🚀 Release Schedule
183+
184+
### **Patch Releases (1.0.X)**
185+
- **Frequency**: As needed for critical fixes
186+
- **Scope**: Bug fixes and security updates
187+
- **Breaking Changes**: Never
188+
189+
### **Minor Releases (1.X.0)**
190+
- **Frequency**: Monthly
191+
- **Scope**: New features and improvements
192+
- **Breaking Changes**: Never
193+
194+
### **Major Releases (X.0.0)**
195+
- **Frequency**: Quarterly
196+
- **Scope**: Major features and architectural changes
197+
- **Breaking Changes**: May include breaking changes
198+
199+
---
200+
201+
## 📝 Contributing to Changelog
202+
203+
When contributing to SmartRAG, please update this changelog:
204+
205+
### **For Bug Fixes:**
206+
```markdown
207+
### 🐛 Fixed
208+
- **Issue Description** - Brief description of what was fixed
209+
```
210+
211+
### **For New Features:**
212+
```markdown
213+
### 🚀 Added
214+
- **Feature Name** - Brief description of the new feature
215+
```
216+
217+
### **For Improvements:**
218+
```markdown
219+
### 🔧 Improved
220+
- **Component Name** - Brief description of the improvement
221+
```
222+
223+
### **For Breaking Changes:**
224+
```markdown
225+
### ⚠️ Breaking Changes
226+
- **Component Name** - Description of breaking changes and migration steps
227+
```
228+
229+
---
230+
231+
## 🔗 Related Links
232+
233+
- [Getting Started]({{ site.baseurl }}/getting-started) - Quick start guide
234+
- [Configuration]({{ site.baseurl }}/configuration) - Configuration options
235+
- [API Reference]({{ site.baseurl }}/api-reference) - API documentation
236+
- [Examples]({{ site.baseurl }}/examples) - Usage examples
237+
- [Contributing]({{ site.baseurl }}/contributing) - How to contribute
238+
239+
---
240+
241+
<div class="text-center mt-5">
242+
<p class="text-muted">
243+
<i class="fas fa-history text-info"></i> Keep track of SmartRAG's evolution
244+
</p>
245+
</div>

0 commit comments

Comments
 (0)