Skip to content

Commit cc1a80c

Browse files
authored
Feature/readme landing page upgrade (#16)
* docs: complete SmartRAG.Demo README synchronization - Sync README.tr.md with README.md according to @00-ANA-INDEKS.mdc rules - Add missing Prerequisites section with .NET 9.0 SDK requirements - Add Configuration Files section with appsettings details - Update Docker Services table with Package Used column - Add Build Issues and Configuration Issues troubleshooting - Add Additional Resources with Package References details - Add Project Information section with target framework details - Ensure complete feature parity between English and Turkish READMEs * fix: correct API hallucinations in README and documentation - Fix Quick Start API calls to use real SmartRAG APIs - Replace connector.ConnectAsync() with appsettings.json configuration - Fix ExecuteQueryAsync() to QueryMultipleDatabasesAsync() - Replace intelligence variable with searchService/documentService - Update audio transcription from Google Speech to Whisper.net - Add comprehensive hallucination prevention rule to Cursor rules - Ensure all code examples match actual SmartRAG implementation Files updated: - README.md, README.tr.md (Quick Start sections) - docs/en/examples.md (8 Use Cases + Privacy Note) - docs/en/configuration/database.md (Multi-DB config) - docs/tr/examples.md (API method names) - docs/tr/configuration/database.md (Multi-DB config) - .cursor/rules/PROJE-YONETIMI.mdc (NEW: Documentation Hallucination Prevention) * docs: update hero slogan to reflect multi-modal capabilities - Changed from 'Multi-Database RAG' to 'Multi-Modal RAG' in hero slogan - Updated English README.md to emphasize databases, documents, images & audio - Updated Turkish README.tr.md with equivalent translation - Fixed README.tr.md synchronization issues (removed duplicate sections) - Reordered sections in README.tr.md to match README.md structure - Ensured both READMEs are now fully synchronized * docs: optimize README structure and improve multi-modal examples - Remove redundant Quick Use Cases section to eliminate duplication - Update Real-World Use Cases with more practical examples from Quick Use Cases - Enhance multi-modal RAG example to include databases, PDFs, OCR images, and audio transcription - Improve example query to show comprehensive data analysis across multiple sources - Synchronize changes between English and Turkish READMEs - Maintain consistent structure and content across both language versions * feat: add comprehensive comparison table with 8 unique SmartRAG features - Add 3 new exclusive features: Fallback Providers, Retry Policies, Batch Embeddings - Highlight all 8 unique features with asterisk (*) markers - Add detailed explanations for each exclusive feature - Synchronize English and Turkish README versions - Enhance competitive positioning with technical differentiators
1 parent f00091f commit cc1a80c

File tree

14 files changed

+1407
-3545
lines changed

14 files changed

+1407
-3545
lines changed

README.md

Lines changed: 146 additions & 1578 deletions
Large diffs are not rendered by default.

README.tr.md

Lines changed: 153 additions & 1560 deletions
Large diffs are not rendered by default.

docs/en/api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -736,7 +736,7 @@ public interface IDatabaseSchemaAnalyzer
736736

737737
### IAudioParserService
738738

739-
**Purpose:** Audio transcription with Google Speech-to-Text
739+
**Purpose:** Audio transcription with Whisper.net (local processing)
740740

741741
```csharp
742742
public interface IAudioParserService

docs/en/configuration/database.md

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -13,33 +13,30 @@ SmartRAG can perform intelligent cross-database queries with multi-database supp
1313

1414
## Multi-Database Connections
1515

16-
```csharp
17-
builder.Services.AddSmartRag(configuration, options =>
16+
Configure databases in `appsettings.json`:
17+
18+
```json
1819
{
19-
options.DatabaseConnections = new List<DatabaseConnectionConfig>
20-
{
21-
new DatabaseConnectionConfig
22-
{
23-
Name = "Sales Database",
24-
Type = DatabaseType.SqlServer,
25-
ConnectionString = "Server=localhost;Database=Sales;...",
26-
IncludedTables = new List<string> { "Orders", "Customers" },
27-
MaxRowsPerTable = 1000,
28-
SanitizeSensitiveData = true
29-
},
30-
new DatabaseConnectionConfig
31-
{
32-
Name = "Inventory Database",
33-
Type = DatabaseType.MySQL,
34-
ConnectionString = "Server=localhost;Database=Inventory;...",
35-
MaxRowsPerTable = 1000
36-
}
37-
};
38-
39-
options.EnableAutoSchemaAnalysis = true;
40-
options.EnablePeriodicSchemaRefresh = true;
41-
options.DefaultSchemaRefreshIntervalMinutes = 60;
42-
});
20+
"SmartRAG": {
21+
"DatabaseConnections": [
22+
{
23+
"Name": "Sales Database",
24+
"ConnectionString": "Server=localhost;Database=Sales;...",
25+
"DatabaseType": "SqlServer",
26+
"IncludedTables": ["Orders", "Customers"],
27+
"MaxRowsPerQuery": 1000,
28+
"Enabled": true
29+
},
30+
{
31+
"Name": "Inventory Database",
32+
"ConnectionString": "Server=localhost;Database=Inventory;...",
33+
"DatabaseType": "MySQL",
34+
"MaxRowsPerQuery": 1000,
35+
"Enabled": true
36+
}
37+
]
38+
}
39+
}
4340
```
4441

4542
---
@@ -227,11 +224,11 @@ new DatabaseConnectionConfig
227224
// Handle connection errors
228225
try
229226
{
230-
var result = await _multiDatabaseQueryCoordinator.QueryAsync(query);
227+
var result = await _multiDatabaseQueryCoordinator.QueryMultipleDatabasesAsync(query);
231228
}
232-
catch (DatabaseConnectionException ex)
229+
catch (Exception ex)
233230
{
234-
_logger.LogError(ex, "Database connection error: {DatabaseName}", ex.DatabaseName);
231+
_logger.LogError(ex, "Database connection error");
235232
// Implement fallback strategy
236233
}
237234
```
@@ -247,7 +244,7 @@ catch (DatabaseConnectionException ex)
247244
<i class="fas fa-microphone"></i>
248245
</div>
249246
<h3>Audio & OCR</h3>
250-
<p>Google Speech-to-Text and Tesseract OCR configuration</p>
247+
<p>Whisper.net and Tesseract OCR configuration</p>
251248
<a href="{{ site.baseurl }}/en/configuration/audio-ocr" class="btn btn-outline-primary btn-sm mt-3">
252249
Audio & OCR
253250
</a>

docs/en/configuration/storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ options.StorageProvider = StorageProvider.Qdrant;
241241
<i class="fas fa-microphone"></i>
242242
</div>
243243
<h3>Audio & OCR</h3>
244-
<p>Google Speech-to-Text and Tesseract OCR</p>
244+
<p>Whisper.net and Tesseract OCR</p>
245245
<a href="{{ site.baseurl }}/en/configuration/audio-ocr" class="btn btn-outline-primary btn-sm mt-3">
246246
Audio & OCR
247247
</a>

0 commit comments

Comments
 (0)